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

Contents

Creating a Request
Request Lenses
Destructuring the Response
Response Lenses

Description

Provides metadata information about a bot.

Synopsis

data DescribeBot = DescribeBot' {
- botId :: Text
}
newDescribeBot :: Text -> DescribeBot
describeBot_botId :: Lens' DescribeBot Text
data DescribeBotResponse = DescribeBotResponse' {
- botId :: Maybe Text
- botName :: Maybe Text
- botStatus :: Maybe BotStatus
- creationDateTime :: Maybe POSIX
- dataPrivacy :: Maybe DataPrivacy
- description :: Maybe Text
- idleSessionTTLInSeconds :: Maybe Natural
- lastUpdatedDateTime :: Maybe POSIX
- roleArn :: Maybe Text
- httpStatus :: Int
}
newDescribeBotResponse :: Int -> DescribeBotResponse
describeBotResponse_botId :: Lens' DescribeBotResponse (Maybe Text)
describeBotResponse_botName :: Lens' DescribeBotResponse (Maybe Text)
describeBotResponse_botStatus :: Lens' DescribeBotResponse (Maybe BotStatus)
describeBotResponse_creationDateTime :: Lens' DescribeBotResponse (Maybe UTCTime)
describeBotResponse_dataPrivacy :: Lens' DescribeBotResponse (Maybe DataPrivacy)
describeBotResponse_description :: Lens' DescribeBotResponse (Maybe Text)
describeBotResponse_idleSessionTTLInSeconds :: Lens' DescribeBotResponse (Maybe Natural)
describeBotResponse_lastUpdatedDateTime :: Lens' DescribeBotResponse (Maybe UTCTime)
describeBotResponse_roleArn :: Lens' DescribeBotResponse (Maybe Text)
describeBotResponse_httpStatus :: Lens' DescribeBotResponse Int

Creating a Request

data DescribeBot Source #

See: newDescribeBot smart constructor.

Constructors

DescribeBot'
Fields botId :: Text The unique identifier of the bot to describe.

Instances

Instances details

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

newDescribeBot Source #

Arguments

:: Text	`DescribeBot`
-> DescribeBot

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

DescribeBot, describeBot_botId - The unique identifier of the bot to describe.

Request Lenses

describeBot_botId :: Lens' DescribeBot Text Source #

The unique identifier of the bot to describe.

Destructuring the Response

data DescribeBotResponse Source #

See: newDescribeBotResponse smart constructor.

Constructors

DescribeBotResponse'

Fields

botId :: Maybe Text
The unique identifier of the bot.
botName :: Maybe Text
The name of the bot.
botStatus :: Maybe BotStatus
The current status of the bot. When the status is Available the bot is ready to be used in conversations with users.
creationDateTime :: Maybe POSIX
A timestamp of the date and time that the bot was created.
dataPrivacy :: Maybe DataPrivacy
Settings for managing data privacy of the bot and its conversations with users.
description :: Maybe Text
The description of the bot.
idleSessionTTLInSeconds :: Maybe Natural
The maximum time in seconds that Amazon Lex retains the data gathered in a conversation.
lastUpdatedDateTime :: Maybe POSIX
A timestamp of the date and time that the bot was last updated.
roleArn :: Maybe Text
The Amazon Resource Name (ARN) of an IAM role that has permission to access the bot.
httpStatus :: Int
The response's http status code.

Instances

Instances details

Generic DescribeBotResponse Source #
Instance details Defined in Amazonka.LexV2Models.DescribeBot Associated Types type Rep DescribeBotResponse :: Type -> Type # Methods from :: DescribeBotResponse -> Rep DescribeBotResponse x # to :: Rep DescribeBotResponse x -> DescribeBotResponse #
Read DescribeBotResponse Source #
Instance details Defined in Amazonka.LexV2Models.DescribeBot Methods readsPrec :: Int -> ReadS DescribeBotResponse # readList :: ReadS [DescribeBotResponse] # readPrec :: ReadPrec DescribeBotResponse # readListPrec :: ReadPrec [DescribeBotResponse] #
Show DescribeBotResponse Source #
Instance details Defined in Amazonka.LexV2Models.DescribeBot Methods showsPrec :: Int -> DescribeBotResponse -> ShowS # show :: DescribeBotResponse -> String # showList :: [DescribeBotResponse] -> ShowS #
NFData DescribeBotResponse Source #
Instance details Defined in Amazonka.LexV2Models.DescribeBot Methods rnf :: DescribeBotResponse -> () #
Eq DescribeBotResponse Source #
Instance details Defined in Amazonka.LexV2Models.DescribeBot Methods (==) :: DescribeBotResponse -> DescribeBotResponse -> Bool # (/=) :: DescribeBotResponse -> DescribeBotResponse -> Bool #
type Rep DescribeBotResponse Source #
Instance details Defined in Amazonka.LexV2Models.DescribeBot type Rep DescribeBotResponse = D1 ('MetaData "DescribeBotResponse" "Amazonka.LexV2Models.DescribeBot" "amazonka-lexv2-models-2.0-5mExjJXBfuO6j0ascNcayE" 'False) (C1 ('MetaCons "DescribeBotResponse'" 'PrefixI 'True) (((S1 ('MetaSel ('Just "botId") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :: S1 ('MetaSel ('Just "botName") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text))) :: (S1 ('MetaSel ('Just "botStatus") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe BotStatus)) :: (S1 ('MetaSel ('Just "creationDateTime") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe POSIX)) :: S1 ('MetaSel ('Just "dataPrivacy") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe DataPrivacy))))) :: ((S1 ('MetaSel ('Just "description") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :: S1 ('MetaSel ('Just "idleSessionTTLInSeconds") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Natural))) :: (S1 ('MetaSel ('Just "lastUpdatedDateTime") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe POSIX)) :: (S1 ('MetaSel ('Just "roleArn") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :*: S1 ('MetaSel ('Just "httpStatus") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Int))))))

newDescribeBotResponse Source #

Arguments

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

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

DescribeBot, describeBotResponse_botId - The unique identifier of the bot.

DescribeBotResponse, describeBotResponse_botName - The name of the bot.

DescribeBotResponse, describeBotResponse_botStatus - The current status of the bot. When the status is Available the bot is ready to be used in conversations with users.

DescribeBotResponse, describeBotResponse_creationDateTime - A timestamp of the date and time that the bot was created.

DescribeBotResponse, describeBotResponse_dataPrivacy - Settings for managing data privacy of the bot and its conversations with users.

DescribeBotResponse, describeBotResponse_description - The description of the bot.

DescribeBotResponse, describeBotResponse_idleSessionTTLInSeconds - The maximum time in seconds that Amazon Lex retains the data gathered in a conversation.

DescribeBotResponse, describeBotResponse_lastUpdatedDateTime - A timestamp of the date and time that the bot was last updated.

DescribeBotResponse, describeBotResponse_roleArn - The Amazon Resource Name (ARN) of an IAM role that has permission to access the bot.

$sel:httpStatus:DescribeBotResponse', describeBotResponse_httpStatus - The response's http status code.

Response Lenses

describeBotResponse_botId :: Lens' DescribeBotResponse (Maybe Text) Source #

The unique identifier of the bot.

describeBotResponse_botName :: Lens' DescribeBotResponse (Maybe Text) Source #

The name of the bot.

describeBotResponse_botStatus :: Lens' DescribeBotResponse (Maybe BotStatus) Source #

The current status of the bot. When the status is Available the bot is ready to be used in conversations with users.

describeBotResponse_creationDateTime :: Lens' DescribeBotResponse (Maybe UTCTime) Source #

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

describeBotResponse_dataPrivacy :: Lens' DescribeBotResponse (Maybe DataPrivacy) Source #

Settings for managing data privacy of the bot and its conversations with users.

describeBotResponse_description :: Lens' DescribeBotResponse (Maybe Text) Source #

The description of the bot.

describeBotResponse_idleSessionTTLInSeconds :: Lens' DescribeBotResponse (Maybe Natural) Source #

The maximum time in seconds that Amazon Lex retains the data gathered in a conversation.

describeBotResponse_lastUpdatedDateTime :: Lens' DescribeBotResponse (Maybe UTCTime) Source #

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

describeBotResponse_roleArn :: Lens' DescribeBotResponse (Maybe Text) Source #

The Amazon Resource Name (ARN) of an IAM role that has permission to access the bot.

describeBotResponse_httpStatus :: Lens' DescribeBotResponse Int Source #

The response's http status code.