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

Contents

Creating a Request
Request Lenses
Destructuring the Response
Response Lenses

Description

Updates the configuration of an existing bot.

Synopsis

data UpdateBot = UpdateBot' {
- description :: Maybe Text
- botId :: Text
- botName :: Text
- roleArn :: Text
- dataPrivacy :: DataPrivacy
- idleSessionTTLInSeconds :: Natural
}
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' {
- 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
}
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

data UpdateBot Source #

See: newUpdateBot smart constructor.

Constructors

UpdateBot'

Fields

description :: Maybe Text
A description of the bot.
botId :: Text
The unique identifier of the bot to update. This identifier is returned by the CreateBot operation.
botName :: Text
The new name of the bot. The name must be unique in the account that creates the bot.
roleArn :: Text
The Amazon Resource Name (ARN) of an IAM role that has permissions to access the bot.
dataPrivacy :: DataPrivacy
Provides information on additional privacy protections Amazon Lex should use with the bot's data.
idleSessionTTLInSeconds :: Natural
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.

Instances

Instances details

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

newUpdateBot Source #

Arguments

:: Text	`UpdateBot`
-> Text	`UpdateBot`
-> Text	`UpdateBot`
-> DataPrivacy	`UpdateBot`
-> Natural	`UpdateBot`
-> UpdateBot

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_description :: Lens' UpdateBot (Maybe Text) Source #

A description of the bot.

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.

Constructors

UpdateBotResponse'

Fields

botId :: Maybe Text
The unique identifier of the bot that was updated.
botName :: Maybe Text
The name of the bot after the update.
botStatus :: Maybe 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.
creationDateTime :: Maybe POSIX
A timestamp of the date and time that the bot was created.
dataPrivacy :: Maybe DataPrivacy
The data privacy settings for the bot after the update.
description :: Maybe Text
The description of the bot after the update.
idleSessionTTLInSeconds :: Maybe Natural
The session timeout, in seconds, for the bot after the update.
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 the IAM role used by the bot after the update.
httpStatus :: Int
The response's http status code.

Instances

Instances details

Generic UpdateBotResponse Source #
Instance details Defined in Amazonka.LexV2Models.UpdateBot Associated Types type Rep UpdateBotResponse :: Type -> Type # Methods from :: UpdateBotResponse -> Rep UpdateBotResponse x # to :: Rep UpdateBotResponse x -> UpdateBotResponse #
Read UpdateBotResponse Source #
Instance details Defined in Amazonka.LexV2Models.UpdateBot Methods readsPrec :: Int -> ReadS UpdateBotResponse # readList :: ReadS [UpdateBotResponse] # readPrec :: ReadPrec UpdateBotResponse # readListPrec :: ReadPrec [UpdateBotResponse] #
Show UpdateBotResponse Source #
Instance details Defined in Amazonka.LexV2Models.UpdateBot Methods showsPrec :: Int -> UpdateBotResponse -> ShowS # show :: UpdateBotResponse -> String # showList :: [UpdateBotResponse] -> ShowS #
NFData UpdateBotResponse Source #
Instance details Defined in Amazonka.LexV2Models.UpdateBot Methods rnf :: UpdateBotResponse -> () #
Eq UpdateBotResponse Source #
Instance details Defined in Amazonka.LexV2Models.UpdateBot Methods (==) :: UpdateBotResponse -> UpdateBotResponse -> Bool # (/=) :: UpdateBotResponse -> UpdateBotResponse -> Bool #
type Rep UpdateBotResponse Source #
Instance details Defined in Amazonka.LexV2Models.UpdateBot type Rep UpdateBotResponse = D1 ('MetaData "UpdateBotResponse" "Amazonka.LexV2Models.UpdateBot" "amazonka-lexv2-models-2.0-5mExjJXBfuO6j0ascNcayE" 'False) (C1 ('MetaCons "UpdateBotResponse'" '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))))))

newUpdateBotResponse Source #

Arguments

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

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.