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 |
Provides metadata information about a bot.
Synopsis
- data DescribeBot = DescribeBot' {}
- newDescribeBot :: Text -> DescribeBot
- describeBot_botId :: Lens' DescribeBot Text
- data DescribeBotResponse = DescribeBotResponse' {}
- 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.
Instances
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.
DescribeBotResponse' | |
|
Instances
newDescribeBotResponse Source #
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.