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

Contents

Creating a Request
Request Lenses
Destructuring the Response
Response Lenses

Description

Get information about a specific bot alias.

Synopsis

Creating a Request

data DescribeBotAlias Source #

See: newDescribeBotAlias smart constructor.

Constructors

DescribeBotAlias'
Fields botAliasId :: Text The identifier of the bot alias to describe. botId :: Text The identifier of the bot associated with the bot alias to describe.

Instances

Instances details

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

newDescribeBotAlias Source #

Arguments

:: Text	`DescribeBotAlias`
-> Text	`DescribeBotAlias`
-> DescribeBotAlias

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

DescribeBotAlias, describeBotAlias_botAliasId - The identifier of the bot alias to describe.

DescribeBotAlias, describeBotAlias_botId - The identifier of the bot associated with the bot alias to describe.

Request Lenses

describeBotAlias_botAliasId :: Lens' DescribeBotAlias Text Source #

The identifier of the bot alias to describe.

describeBotAlias_botId :: Lens' DescribeBotAlias Text Source #

The identifier of the bot associated with the bot alias to describe.

Destructuring the Response

data DescribeBotAliasResponse Source #

See: newDescribeBotAliasResponse smart constructor.

Constructors

DescribeBotAliasResponse'

Fields

botAliasHistoryEvents :: Maybe [BotAliasHistoryEvent]
A list of events that affect a bot alias. For example, an event is recorded when the version that the alias points to changes.
botAliasId :: Maybe Text
The identifier of the bot alias.
botAliasLocaleSettings :: Maybe (HashMap Text BotAliasLocaleSettings)
The locale settings that are unique to the alias.
botAliasName :: Maybe Text
The name of the bot alias.
botAliasStatus :: Maybe BotAliasStatus
The current status of the alias. When the alias is Available, the alias is ready for use with your bot.
botId :: Maybe Text
The identifier of the bot associated with the bot alias.
botVersion :: Maybe Text
The version of the bot associated with the bot alias.
conversationLogSettings :: Maybe ConversationLogSettings
Specifics of how Amazon Lex logs text and audio conversations with the bot associated with the alias.
creationDateTime :: Maybe POSIX
A timestamp of the date and time that the alias was created.
description :: Maybe Text
The description of the bot alias.
lastUpdatedDateTime :: Maybe POSIX
A timestamp of the date and time that the alias was last updated.
sentimentAnalysisSettings :: Maybe SentimentAnalysisSettings
httpStatus :: Int
The response's http status code.

Instances

Instances details

Generic DescribeBotAliasResponse Source #
Instance details Defined in Amazonka.LexV2Models.DescribeBotAlias Associated Types type Rep DescribeBotAliasResponse :: Type -> Type # Methods from :: DescribeBotAliasResponse -> Rep DescribeBotAliasResponse x # to :: Rep DescribeBotAliasResponse x -> DescribeBotAliasResponse #
Read DescribeBotAliasResponse Source #
Instance details Defined in Amazonka.LexV2Models.DescribeBotAlias Methods readsPrec :: Int -> ReadS DescribeBotAliasResponse # readList :: ReadS [DescribeBotAliasResponse] # readPrec :: ReadPrec DescribeBotAliasResponse # readListPrec :: ReadPrec [DescribeBotAliasResponse] #
Show DescribeBotAliasResponse Source #
Instance details Defined in Amazonka.LexV2Models.DescribeBotAlias Methods showsPrec :: Int -> DescribeBotAliasResponse -> ShowS # show :: DescribeBotAliasResponse -> String # showList :: [DescribeBotAliasResponse] -> ShowS #
NFData DescribeBotAliasResponse Source #
Instance details Defined in Amazonka.LexV2Models.DescribeBotAlias Methods rnf :: DescribeBotAliasResponse -> () #
Eq DescribeBotAliasResponse Source #
Instance details Defined in Amazonka.LexV2Models.DescribeBotAlias Methods (==) :: DescribeBotAliasResponse -> DescribeBotAliasResponse -> Bool # (/=) :: DescribeBotAliasResponse -> DescribeBotAliasResponse -> Bool #
type Rep DescribeBotAliasResponse Source #
Instance details Defined in Amazonka.LexV2Models.DescribeBotAlias type Rep DescribeBotAliasResponse = D1 ('MetaData "DescribeBotAliasResponse" "Amazonka.LexV2Models.DescribeBotAlias" "amazonka-lexv2-models-2.0-5mExjJXBfuO6j0ascNcayE" 'False) (C1 ('MetaCons "DescribeBotAliasResponse'" 'PrefixI 'True) (((S1 ('MetaSel ('Just "botAliasHistoryEvents") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe [BotAliasHistoryEvent])) :: (S1 ('MetaSel ('Just "botAliasId") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :: S1 ('MetaSel ('Just "botAliasLocaleSettings") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe (HashMap Text BotAliasLocaleSettings))))) :: (S1 ('MetaSel ('Just "botAliasName") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :: (S1 ('MetaSel ('Just "botAliasStatus") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe BotAliasStatus)) :: S1 ('MetaSel ('Just "botId") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text))))) :: ((S1 ('MetaSel ('Just "botVersion") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :: (S1 ('MetaSel ('Just "conversationLogSettings") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe ConversationLogSettings)) :: S1 ('MetaSel ('Just "creationDateTime") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe POSIX)))) :: ((S1 ('MetaSel ('Just "description") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :: S1 ('MetaSel ('Just "lastUpdatedDateTime") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe POSIX))) :: (S1 ('MetaSel ('Just "sentimentAnalysisSettings") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe SentimentAnalysisSettings)) :: S1 ('MetaSel ('Just "httpStatus") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Int))))))

newDescribeBotAliasResponse Source #

Arguments

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

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

$sel:botAliasHistoryEvents:DescribeBotAliasResponse', describeBotAliasResponse_botAliasHistoryEvents - A list of events that affect a bot alias. For example, an event is recorded when the version that the alias points to changes.

DescribeBotAlias, describeBotAliasResponse_botAliasId - The identifier of the bot alias.

$sel:botAliasLocaleSettings:DescribeBotAliasResponse', describeBotAliasResponse_botAliasLocaleSettings - The locale settings that are unique to the alias.

DescribeBotAliasResponse, describeBotAliasResponse_botAliasName - The name of the bot alias.

DescribeBotAliasResponse, describeBotAliasResponse_botAliasStatus - The current status of the alias. When the alias is Available, the alias is ready for use with your bot.

DescribeBotAlias, describeBotAliasResponse_botId - The identifier of the bot associated with the bot alias.

DescribeBotAliasResponse, describeBotAliasResponse_botVersion - The version of the bot associated with the bot alias.

$sel:conversationLogSettings:DescribeBotAliasResponse', describeBotAliasResponse_conversationLogSettings - Specifics of how Amazon Lex logs text and audio conversations with the bot associated with the alias.

DescribeBotAliasResponse, describeBotAliasResponse_creationDateTime - A timestamp of the date and time that the alias was created.

DescribeBotAliasResponse, describeBotAliasResponse_description - The description of the bot alias.

DescribeBotAliasResponse, describeBotAliasResponse_lastUpdatedDateTime - A timestamp of the date and time that the alias was last updated.

$sel:sentimentAnalysisSettings:DescribeBotAliasResponse', describeBotAliasResponse_sentimentAnalysisSettings - Undocumented member.

$sel:httpStatus:DescribeBotAliasResponse', describeBotAliasResponse_httpStatus - The response's http status code.

Response Lenses

describeBotAliasResponse_botAliasHistoryEvents :: Lens' DescribeBotAliasResponse (Maybe [BotAliasHistoryEvent]) Source #

A list of events that affect a bot alias. For example, an event is recorded when the version that the alias points to changes.

describeBotAliasResponse_botAliasId :: Lens' DescribeBotAliasResponse (Maybe Text) Source #

The identifier of the bot alias.

describeBotAliasResponse_botAliasLocaleSettings :: Lens' DescribeBotAliasResponse (Maybe (HashMap Text BotAliasLocaleSettings)) Source #

The locale settings that are unique to the alias.

describeBotAliasResponse_botAliasName :: Lens' DescribeBotAliasResponse (Maybe Text) Source #

The name of the bot alias.

describeBotAliasResponse_botAliasStatus :: Lens' DescribeBotAliasResponse (Maybe BotAliasStatus) Source #

The current status of the alias. When the alias is Available, the alias is ready for use with your bot.

describeBotAliasResponse_botId :: Lens' DescribeBotAliasResponse (Maybe Text) Source #

The identifier of the bot associated with the bot alias.

describeBotAliasResponse_botVersion :: Lens' DescribeBotAliasResponse (Maybe Text) Source #

The version of the bot associated with the bot alias.

describeBotAliasResponse_conversationLogSettings :: Lens' DescribeBotAliasResponse (Maybe ConversationLogSettings) Source #

Specifics of how Amazon Lex logs text and audio conversations with the bot associated with the alias.

describeBotAliasResponse_creationDateTime :: Lens' DescribeBotAliasResponse (Maybe UTCTime) Source #

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

describeBotAliasResponse_description :: Lens' DescribeBotAliasResponse (Maybe Text) Source #

The description of the bot alias.

describeBotAliasResponse_lastUpdatedDateTime :: Lens' DescribeBotAliasResponse (Maybe UTCTime) Source #

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

describeBotAliasResponse_sentimentAnalysisSettings :: Lens' DescribeBotAliasResponse (Maybe SentimentAnalysisSettings) Source #

Undocumented member.

describeBotAliasResponse_httpStatus :: Lens' DescribeBotAliasResponse Int Source #

The response's http status code.