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 |
Updates the configuration of an existing bot.
Synopsis
- data UpdateBot = UpdateBot' {}
- newUpdateBot :: Text -> Text -> Text -> DataPrivacy -> Natural -> UpdateBot
- updateBot_description :: Lens' UpdateBot (Maybe Text)
- updateBot_botId :: Lens' UpdateBot Text
- updateBot_botName :: Lens' UpdateBot Text
- updateBot_roleArn :: Lens' UpdateBot Text
- updateBot_dataPrivacy :: Lens' UpdateBot DataPrivacy
- updateBot_idleSessionTTLInSeconds :: Lens' UpdateBot Natural
- data UpdateBotResponse = UpdateBotResponse' {}
- newUpdateBotResponse :: Int -> UpdateBotResponse
- updateBotResponse_botId :: Lens' UpdateBotResponse (Maybe Text)
- updateBotResponse_botName :: Lens' UpdateBotResponse (Maybe Text)
- updateBotResponse_botStatus :: Lens' UpdateBotResponse (Maybe BotStatus)
- updateBotResponse_creationDateTime :: Lens' UpdateBotResponse (Maybe UTCTime)
- updateBotResponse_dataPrivacy :: Lens' UpdateBotResponse (Maybe DataPrivacy)
- updateBotResponse_description :: Lens' UpdateBotResponse (Maybe Text)
- updateBotResponse_idleSessionTTLInSeconds :: Lens' UpdateBotResponse (Maybe Natural)
- updateBotResponse_lastUpdatedDateTime :: Lens' UpdateBotResponse (Maybe UTCTime)
- updateBotResponse_roleArn :: Lens' UpdateBotResponse (Maybe Text)
- updateBotResponse_httpStatus :: Lens' UpdateBotResponse Int
Creating a Request
See: newUpdateBot
smart constructor.
UpdateBot' | |
|
Instances
Create a value of UpdateBot
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:
UpdateBot
, updateBot_description
- A description of the bot.
UpdateBot
, updateBot_botId
- The unique identifier of the bot to update. This identifier is returned
by the
CreateBot
operation.
UpdateBot
, updateBot_botName
- The new name of the bot. The name must be unique in the account that
creates the bot.
UpdateBot
, updateBot_roleArn
- The Amazon Resource Name (ARN) of an IAM role that has permissions to
access the bot.
UpdateBot
, updateBot_dataPrivacy
- Provides information on additional privacy protections Amazon Lex should
use with the bot's data.
UpdateBot
, updateBot_idleSessionTTLInSeconds
- The time, in seconds, that Amazon Lex should keep information about a
user's conversation with the bot.
A user interaction remains active for the amount of time specified. If no conversation occurs during this time, the session expires and Amazon Lex deletes any data provided before the timeout.
You can specify between 60 (1 minute) and 86,400 (24 hours) seconds.
Request Lenses
updateBot_botId :: Lens' UpdateBot Text Source #
The unique identifier of the bot to update. This identifier is returned by the CreateBot operation.
updateBot_botName :: Lens' UpdateBot Text Source #
The new name of the bot. The name must be unique in the account that creates the bot.
updateBot_roleArn :: Lens' UpdateBot Text Source #
The Amazon Resource Name (ARN) of an IAM role that has permissions to access the bot.
updateBot_dataPrivacy :: Lens' UpdateBot DataPrivacy Source #
Provides information on additional privacy protections Amazon Lex should use with the bot's data.
updateBot_idleSessionTTLInSeconds :: Lens' UpdateBot Natural Source #
The time, in seconds, that Amazon Lex should keep information about a user's conversation with the bot.
A user interaction remains active for the amount of time specified. If no conversation occurs during this time, the session expires and Amazon Lex deletes any data provided before the timeout.
You can specify between 60 (1 minute) and 86,400 (24 hours) seconds.
Destructuring the Response
data UpdateBotResponse Source #
See: newUpdateBotResponse
smart constructor.
UpdateBotResponse' | |
|
Instances
Create a value of UpdateBotResponse
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:
UpdateBot
, updateBotResponse_botId
- The unique identifier of the bot that was updated.
UpdateBot
, updateBotResponse_botName
- The name of the bot after the update.
UpdateBotResponse
, updateBotResponse_botStatus
- Shows the current status of the bot. The bot is first in the Creating
status. Once the bot is read for use, it changes to the Available
status. After the bot is created, you can use the DRAFT
version of the
bot.
UpdateBotResponse
, updateBotResponse_creationDateTime
- A timestamp of the date and time that the bot was created.
UpdateBot
, updateBotResponse_dataPrivacy
- The data privacy settings for the bot after the update.
UpdateBot
, updateBotResponse_description
- The description of the bot after the update.
UpdateBot
, updateBotResponse_idleSessionTTLInSeconds
- The session timeout, in seconds, for the bot after the update.
UpdateBotResponse
, updateBotResponse_lastUpdatedDateTime
- A timestamp of the date and time that the bot was last updated.
UpdateBot
, updateBotResponse_roleArn
- The Amazon Resource Name (ARN) of the IAM role used by the bot after the
update.
$sel:httpStatus:UpdateBotResponse'
, updateBotResponse_httpStatus
- The response's http status code.
Response Lenses
updateBotResponse_botId :: Lens' UpdateBotResponse (Maybe Text) Source #
The unique identifier of the bot that was updated.
updateBotResponse_botName :: Lens' UpdateBotResponse (Maybe Text) Source #
The name of the bot after the update.
updateBotResponse_botStatus :: Lens' UpdateBotResponse (Maybe BotStatus) Source #
Shows the current status of the bot. The bot is first in the Creating
status. Once the bot is read for use, it changes to the Available
status. After the bot is created, you can use the DRAFT
version of the
bot.
updateBotResponse_creationDateTime :: Lens' UpdateBotResponse (Maybe UTCTime) Source #
A timestamp of the date and time that the bot was created.
updateBotResponse_dataPrivacy :: Lens' UpdateBotResponse (Maybe DataPrivacy) Source #
The data privacy settings for the bot after the update.
updateBotResponse_description :: Lens' UpdateBotResponse (Maybe Text) Source #
The description of the bot after the update.
updateBotResponse_idleSessionTTLInSeconds :: Lens' UpdateBotResponse (Maybe Natural) Source #
The session timeout, in seconds, for the bot after the update.
updateBotResponse_lastUpdatedDateTime :: Lens' UpdateBotResponse (Maybe UTCTime) Source #
A timestamp of the date and time that the bot was last updated.
updateBotResponse_roleArn :: Lens' UpdateBotResponse (Maybe Text) Source #
The Amazon Resource Name (ARN) of the IAM role used by the bot after the update.
updateBotResponse_httpStatus :: Lens' UpdateBotResponse Int Source #
The response's http status code.