Copyright	(c) 2013-2023 Brendan Hay
License	Mozilla Public License, v. 2.0.
Maintainer	Brendan Hay
Stability	auto-generated
Portability	non-portable (GHC extensions)
Safe Haskell	Safe-Inferred
Language	Haskell2010

Amazonka.LexV2Models.DescribeBotLocale

Contents

Creating a Request
Request Lenses
Destructuring the Response
Response Lenses

Description

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

Synopsis

data DescribeBotLocale = DescribeBotLocale' {
- botId :: Text
- botVersion :: Text
- localeId :: Text
}
newDescribeBotLocale :: Text -> Text -> Text -> DescribeBotLocale
describeBotLocale_botId :: Lens' DescribeBotLocale Text
describeBotLocale_botVersion :: Lens' DescribeBotLocale Text
describeBotLocale_localeId :: Lens' DescribeBotLocale Text
data DescribeBotLocaleResponse = DescribeBotLocaleResponse' {
- botId :: Maybe Text
- botLocaleHistoryEvents :: Maybe [BotLocaleHistoryEvent]
- botLocaleStatus :: Maybe BotLocaleStatus
- botVersion :: Maybe Text
- creationDateTime :: Maybe POSIX
- description :: Maybe Text
- failureReasons :: Maybe [Text]
- intentsCount :: Maybe Int
- lastBuildSubmittedDateTime :: Maybe POSIX
- lastUpdatedDateTime :: Maybe POSIX
- localeId :: Maybe Text
- localeName :: Maybe Text
- nluIntentConfidenceThreshold :: Maybe Double
- recommendedActions :: Maybe [Text]
- slotTypesCount :: Maybe Int
- voiceSettings :: Maybe VoiceSettings
- httpStatus :: Int
}
newDescribeBotLocaleResponse :: Int -> DescribeBotLocaleResponse
describeBotLocaleResponse_botId :: Lens' DescribeBotLocaleResponse (Maybe Text)
describeBotLocaleResponse_botLocaleHistoryEvents :: Lens' DescribeBotLocaleResponse (Maybe [BotLocaleHistoryEvent])
describeBotLocaleResponse_botLocaleStatus :: Lens' DescribeBotLocaleResponse (Maybe BotLocaleStatus)
describeBotLocaleResponse_botVersion :: Lens' DescribeBotLocaleResponse (Maybe Text)
describeBotLocaleResponse_creationDateTime :: Lens' DescribeBotLocaleResponse (Maybe UTCTime)
describeBotLocaleResponse_description :: Lens' DescribeBotLocaleResponse (Maybe Text)
describeBotLocaleResponse_failureReasons :: Lens' DescribeBotLocaleResponse (Maybe [Text])
describeBotLocaleResponse_intentsCount :: Lens' DescribeBotLocaleResponse (Maybe Int)
describeBotLocaleResponse_lastBuildSubmittedDateTime :: Lens' DescribeBotLocaleResponse (Maybe UTCTime)
describeBotLocaleResponse_lastUpdatedDateTime :: Lens' DescribeBotLocaleResponse (Maybe UTCTime)
describeBotLocaleResponse_localeId :: Lens' DescribeBotLocaleResponse (Maybe Text)
describeBotLocaleResponse_localeName :: Lens' DescribeBotLocaleResponse (Maybe Text)
describeBotLocaleResponse_nluIntentConfidenceThreshold :: Lens' DescribeBotLocaleResponse (Maybe Double)
describeBotLocaleResponse_recommendedActions :: Lens' DescribeBotLocaleResponse (Maybe [Text])
describeBotLocaleResponse_slotTypesCount :: Lens' DescribeBotLocaleResponse (Maybe Int)
describeBotLocaleResponse_voiceSettings :: Lens' DescribeBotLocaleResponse (Maybe VoiceSettings)
describeBotLocaleResponse_httpStatus :: Lens' DescribeBotLocaleResponse Int

Creating a Request

data DescribeBotLocale Source #

See: newDescribeBotLocale smart constructor.

Constructors

DescribeBotLocale'
Fields botId :: Text The identifier of the bot associated with the locale. botVersion :: Text The identifier of the version of the bot associated with the locale. localeId :: Text The unique identifier of the locale to describe. The string must match one of the supported locales. For more information, see Supported languages.

Instances

Instances details

ToHeaders DescribeBotLocale Source #
Instance details Defined in Amazonka.LexV2Models.DescribeBotLocale Methods toHeaders :: DescribeBotLocale -> [Header] #
ToPath DescribeBotLocale Source #
Instance details Defined in Amazonka.LexV2Models.DescribeBotLocale Methods toPath :: DescribeBotLocale -> ByteString #
ToQuery DescribeBotLocale Source #
Instance details Defined in Amazonka.LexV2Models.DescribeBotLocale Methods toQuery :: DescribeBotLocale -> QueryString #
AWSRequest DescribeBotLocale Source #
Instance details Defined in Amazonka.LexV2Models.DescribeBotLocale Associated Types type AWSResponse DescribeBotLocale # Methods request :: (Service -> Service) -> DescribeBotLocale -> Request DescribeBotLocale # response :: MonadResource m => (ByteStringLazy -> IO ByteStringLazy) -> Service -> Proxy DescribeBotLocale -> ClientResponse ClientBody -> m (Either Error (ClientResponse (AWSResponse DescribeBotLocale))) #
Generic DescribeBotLocale Source #
Instance details Defined in Amazonka.LexV2Models.DescribeBotLocale Associated Types type Rep DescribeBotLocale :: Type -> Type # Methods from :: DescribeBotLocale -> Rep DescribeBotLocale x # to :: Rep DescribeBotLocale x -> DescribeBotLocale #
Read DescribeBotLocale Source #
Instance details Defined in Amazonka.LexV2Models.DescribeBotLocale Methods readsPrec :: Int -> ReadS DescribeBotLocale # readList :: ReadS [DescribeBotLocale] # readPrec :: ReadPrec DescribeBotLocale # readListPrec :: ReadPrec [DescribeBotLocale] #
Show DescribeBotLocale Source #
Instance details Defined in Amazonka.LexV2Models.DescribeBotLocale Methods showsPrec :: Int -> DescribeBotLocale -> ShowS # show :: DescribeBotLocale -> String # showList :: [DescribeBotLocale] -> ShowS #
NFData DescribeBotLocale Source #
Instance details Defined in Amazonka.LexV2Models.DescribeBotLocale Methods rnf :: DescribeBotLocale -> () #
Eq DescribeBotLocale Source #
Instance details Defined in Amazonka.LexV2Models.DescribeBotLocale Methods (==) :: DescribeBotLocale -> DescribeBotLocale -> Bool # (/=) :: DescribeBotLocale -> DescribeBotLocale -> Bool #
Hashable DescribeBotLocale Source #
Instance details Defined in Amazonka.LexV2Models.DescribeBotLocale Methods hashWithSalt :: Int -> DescribeBotLocale -> Int # hash :: DescribeBotLocale -> Int #
type AWSResponse DescribeBotLocale Source #
Instance details Defined in Amazonka.LexV2Models.DescribeBotLocale type AWSResponse DescribeBotLocale = DescribeBotLocaleResponse
type Rep DescribeBotLocale Source #
Instance details Defined in Amazonka.LexV2Models.DescribeBotLocale type Rep DescribeBotLocale = D1 ('MetaData "DescribeBotLocale" "Amazonka.LexV2Models.DescribeBotLocale" "amazonka-lexv2-models-2.0-5mExjJXBfuO6j0ascNcayE" 'False) (C1 ('MetaCons "DescribeBotLocale'" 'PrefixI 'True) (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))))

newDescribeBotLocale Source #

Arguments

:: Text	`DescribeBotLocale`
-> Text	`DescribeBotLocale`
-> Text	`DescribeBotLocale`
-> DescribeBotLocale

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

DescribeBotLocale, describeBotLocale_botId - The identifier of the bot associated with the locale.

DescribeBotLocale, describeBotLocale_botVersion - The identifier of the version of the bot associated with the locale.

DescribeBotLocale, describeBotLocale_localeId - The unique identifier of the locale to describe. The string must match one of the supported locales. For more information, see Supported languages.

Request Lenses

describeBotLocale_botId :: Lens' DescribeBotLocale Text Source #

The identifier of the bot associated with the locale.

describeBotLocale_botVersion :: Lens' DescribeBotLocale Text Source #

The identifier of the version of the bot associated with the locale.

describeBotLocale_localeId :: Lens' DescribeBotLocale Text Source #

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

Destructuring the Response

data DescribeBotLocaleResponse Source #

See: newDescribeBotLocaleResponse smart constructor.

Constructors

DescribeBotLocaleResponse'

Fields

botId :: Maybe Text
The identifier of the bot associated with the locale.
botLocaleHistoryEvents :: Maybe [BotLocaleHistoryEvent]
History of changes, such as when a locale is used in an alias, that have taken place for the locale.
botLocaleStatus :: Maybe BotLocaleStatus
The status of the bot. If the status is Failed, the reasons for the failure are listed in the failureReasons field.
botVersion :: Maybe Text
The identifier of the version of the bot associated with the locale.
creationDateTime :: Maybe POSIX
The date and time that the locale was created.
description :: Maybe Text
The description of the locale.
failureReasons :: Maybe [Text]
if botLocaleStatus is Failed, Amazon Lex explains why it failed to build the bot.
intentsCount :: Maybe Int
The number of intents defined for the locale.
lastBuildSubmittedDateTime :: Maybe POSIX
The date and time that the locale was last submitted for building.
lastUpdatedDateTime :: Maybe POSIX
The date and time that the locale was last updated.
localeId :: Maybe Text
The unique identifier of the described locale.
localeName :: Maybe Text
The name of the locale.
nluIntentConfidenceThreshold :: Maybe Double
The confidence threshold where Amazon Lex inserts the AMAZON.FallbackIntent and AMAZON.KendraSearchIntent intents in the list of possible intents for an utterance.
recommendedActions :: Maybe [Text]
Recommended actions to take to resolve an error in the failureReasons field.
slotTypesCount :: Maybe Int
The number of slot types defined for the locale.
voiceSettings :: Maybe VoiceSettings
The Amazon Polly voice Amazon Lex uses for voice interaction with the user.
httpStatus :: Int
The response's http status code.

Instances

Instances details

Generic DescribeBotLocaleResponse Source #
Instance details Defined in Amazonka.LexV2Models.DescribeBotLocale Associated Types type Rep DescribeBotLocaleResponse :: Type -> Type # Methods from :: DescribeBotLocaleResponse -> Rep DescribeBotLocaleResponse x # to :: Rep DescribeBotLocaleResponse x -> DescribeBotLocaleResponse #
Read DescribeBotLocaleResponse Source #
Instance details Defined in Amazonka.LexV2Models.DescribeBotLocale Methods readsPrec :: Int -> ReadS DescribeBotLocaleResponse # readList :: ReadS [DescribeBotLocaleResponse] # readPrec :: ReadPrec DescribeBotLocaleResponse # readListPrec :: ReadPrec [DescribeBotLocaleResponse] #
Show DescribeBotLocaleResponse Source #
Instance details Defined in Amazonka.LexV2Models.DescribeBotLocale Methods showsPrec :: Int -> DescribeBotLocaleResponse -> ShowS # show :: DescribeBotLocaleResponse -> String # showList :: [DescribeBotLocaleResponse] -> ShowS #
NFData DescribeBotLocaleResponse Source #
Instance details Defined in Amazonka.LexV2Models.DescribeBotLocale Methods rnf :: DescribeBotLocaleResponse -> () #
Eq DescribeBotLocaleResponse Source #
Instance details Defined in Amazonka.LexV2Models.DescribeBotLocale Methods (==) :: DescribeBotLocaleResponse -> DescribeBotLocaleResponse -> Bool # (/=) :: DescribeBotLocaleResponse -> DescribeBotLocaleResponse -> Bool #
type Rep DescribeBotLocaleResponse Source #
Instance details Defined in Amazonka.LexV2Models.DescribeBotLocale type Rep DescribeBotLocaleResponse = D1 ('MetaData "DescribeBotLocaleResponse" "Amazonka.LexV2Models.DescribeBotLocale" "amazonka-lexv2-models-2.0-5mExjJXBfuO6j0ascNcayE" 'False) (C1 ('MetaCons "DescribeBotLocaleResponse'" 'PrefixI 'True) ((((S1 ('MetaSel ('Just "botId") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :: S1 ('MetaSel ('Just "botLocaleHistoryEvents") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe [BotLocaleHistoryEvent]))) :: (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 "intentsCount") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Int))))) :: (((S1 ('MetaSel ('Just "lastBuildSubmittedDateTime") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe POSIX)) :: 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 "slotTypesCount") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Int)) :: (S1 ('MetaSel ('Just "voiceSettings") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe VoiceSettings)) :: S1 ('MetaSel ('Just "httpStatus") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Int)))))))

newDescribeBotLocaleResponse Source #

Arguments

:: Int	`$sel:httpStatus:DescribeBotLocaleResponse'`
-> DescribeBotLocaleResponse

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

DescribeBotLocale, describeBotLocaleResponse_botId - The identifier of the bot associated with the locale.

$sel:botLocaleHistoryEvents:DescribeBotLocaleResponse', describeBotLocaleResponse_botLocaleHistoryEvents - History of changes, such as when a locale is used in an alias, that have taken place for the locale.

DescribeBotLocaleResponse, describeBotLocaleResponse_botLocaleStatus - The status of the bot. If the status is Failed, the reasons for the failure are listed in the failureReasons field.

DescribeBotLocale, describeBotLocaleResponse_botVersion - The identifier of the version of the bot associated with the locale.

DescribeBotLocaleResponse, describeBotLocaleResponse_creationDateTime - The date and time that the locale was created.

DescribeBotLocaleResponse, describeBotLocaleResponse_description - The description of the locale.

$sel:failureReasons:DescribeBotLocaleResponse', describeBotLocaleResponse_failureReasons - if botLocaleStatus is Failed, Amazon Lex explains why it failed to build the bot.

$sel:intentsCount:DescribeBotLocaleResponse', describeBotLocaleResponse_intentsCount - The number of intents defined for the locale.

DescribeBotLocaleResponse, describeBotLocaleResponse_lastBuildSubmittedDateTime - The date and time that the locale was last submitted for building.

DescribeBotLocaleResponse, describeBotLocaleResponse_lastUpdatedDateTime - The date and time that the locale was last updated.

DescribeBotLocale, describeBotLocaleResponse_localeId - The unique identifier of the described locale.

DescribeBotLocaleResponse, describeBotLocaleResponse_localeName - The name of the locale.

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

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

$sel:slotTypesCount:DescribeBotLocaleResponse', describeBotLocaleResponse_slotTypesCount - The number of slot types defined for the locale.

DescribeBotLocaleResponse, describeBotLocaleResponse_voiceSettings - The Amazon Polly voice Amazon Lex uses for voice interaction with the user.

$sel:httpStatus:DescribeBotLocaleResponse', describeBotLocaleResponse_httpStatus - The response's http status code.

Response Lenses

describeBotLocaleResponse_botId :: Lens' DescribeBotLocaleResponse (Maybe Text) Source #

The identifier of the bot associated with the locale.

describeBotLocaleResponse_botLocaleHistoryEvents :: Lens' DescribeBotLocaleResponse (Maybe [BotLocaleHistoryEvent]) Source #

History of changes, such as when a locale is used in an alias, that have taken place for the locale.

describeBotLocaleResponse_botLocaleStatus :: Lens' DescribeBotLocaleResponse (Maybe BotLocaleStatus) Source #

The status of the bot. If the status is Failed, the reasons for the failure are listed in the failureReasons field.

describeBotLocaleResponse_botVersion :: Lens' DescribeBotLocaleResponse (Maybe Text) Source #

The identifier of the version of the bot associated with the locale.

describeBotLocaleResponse_creationDateTime :: Lens' DescribeBotLocaleResponse (Maybe UTCTime) Source #

The date and time that the locale was created.

describeBotLocaleResponse_description :: Lens' DescribeBotLocaleResponse (Maybe Text) Source #

The description of the locale.

describeBotLocaleResponse_failureReasons :: Lens' DescribeBotLocaleResponse (Maybe [Text]) Source #

if botLocaleStatus is Failed, Amazon Lex explains why it failed to build the bot.

describeBotLocaleResponse_intentsCount :: Lens' DescribeBotLocaleResponse (Maybe Int) Source #

The number of intents defined for the locale.

describeBotLocaleResponse_lastBuildSubmittedDateTime :: Lens' DescribeBotLocaleResponse (Maybe UTCTime) Source #

The date and time that the locale was last submitted for building.

describeBotLocaleResponse_lastUpdatedDateTime :: Lens' DescribeBotLocaleResponse (Maybe UTCTime) Source #

The date and time that the locale was last updated.

describeBotLocaleResponse_localeId :: Lens' DescribeBotLocaleResponse (Maybe Text) Source #

The unique identifier of the described locale.

describeBotLocaleResponse_localeName :: Lens' DescribeBotLocaleResponse (Maybe Text) Source #

The name of the locale.

describeBotLocaleResponse_nluIntentConfidenceThreshold :: Lens' DescribeBotLocaleResponse (Maybe Double) Source #

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

describeBotLocaleResponse_recommendedActions :: Lens' DescribeBotLocaleResponse (Maybe [Text]) Source #

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

describeBotLocaleResponse_slotTypesCount :: Lens' DescribeBotLocaleResponse (Maybe Int) Source #

The number of slot types defined for the locale.

describeBotLocaleResponse_voiceSettings :: Lens' DescribeBotLocaleResponse (Maybe VoiceSettings) Source #

The Amazon Polly voice Amazon Lex uses for voice interaction with the user.

describeBotLocaleResponse_httpStatus :: Lens' DescribeBotLocaleResponse Int Source #

The response's http status code.