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

Contents

Creating a Request
Request Lenses
Destructuring the Response
Response Lenses

Description

Creates an Amazon Lex conversational bot.

Synopsis

data CreateBot = CreateBot' {
- botTags :: Maybe (HashMap Text Text)
- description :: Maybe Text
- testBotAliasTags :: Maybe (HashMap Text Text)
- botName :: Text
- roleArn :: Text
- dataPrivacy :: DataPrivacy
- idleSessionTTLInSeconds :: Natural
}
newCreateBot :: Text -> Text -> DataPrivacy -> Natural -> CreateBot
createBot_botTags :: Lens' CreateBot (Maybe (HashMap Text Text))
createBot_description :: Lens' CreateBot (Maybe Text)
createBot_testBotAliasTags :: Lens' CreateBot (Maybe (HashMap Text Text))
createBot_botName :: Lens' CreateBot Text
createBot_roleArn :: Lens' CreateBot Text
createBot_dataPrivacy :: Lens' CreateBot DataPrivacy
createBot_idleSessionTTLInSeconds :: Lens' CreateBot Natural
data CreateBotResponse = CreateBotResponse' {
- botId :: Maybe Text
- botName :: Maybe Text
- botStatus :: Maybe BotStatus
- botTags :: Maybe (HashMap Text Text)
- creationDateTime :: Maybe POSIX
- dataPrivacy :: Maybe DataPrivacy
- description :: Maybe Text
- idleSessionTTLInSeconds :: Maybe Natural
- roleArn :: Maybe Text
- testBotAliasTags :: Maybe (HashMap Text Text)
- httpStatus :: Int
}
newCreateBotResponse :: Int -> CreateBotResponse
createBotResponse_botId :: Lens' CreateBotResponse (Maybe Text)
createBotResponse_botName :: Lens' CreateBotResponse (Maybe Text)
createBotResponse_botStatus :: Lens' CreateBotResponse (Maybe BotStatus)
createBotResponse_botTags :: Lens' CreateBotResponse (Maybe (HashMap Text Text))
createBotResponse_creationDateTime :: Lens' CreateBotResponse (Maybe UTCTime)
createBotResponse_dataPrivacy :: Lens' CreateBotResponse (Maybe DataPrivacy)
createBotResponse_description :: Lens' CreateBotResponse (Maybe Text)
createBotResponse_idleSessionTTLInSeconds :: Lens' CreateBotResponse (Maybe Natural)
createBotResponse_roleArn :: Lens' CreateBotResponse (Maybe Text)
createBotResponse_testBotAliasTags :: Lens' CreateBotResponse (Maybe (HashMap Text Text))
createBotResponse_httpStatus :: Lens' CreateBotResponse Int

Creating a Request

data CreateBot Source #

See: newCreateBot smart constructor.

Constructors

CreateBot'

Fields

botTags :: Maybe (HashMap Text Text)
A list of tags to add to the bot. You can only add tags when you create a bot. You can't use the UpdateBot operation to update tags. To update tags, use the TagResource operation.
description :: Maybe Text
A description of the bot. It appears in lists to help you identify a particular bot.
testBotAliasTags :: Maybe (HashMap Text Text)
A list of tags to add to the test alias for a bot. You can only add tags when you create a bot. You can't use the UpdateAlias operation to update tags. To update tags on the test alias, use the TagResource operation.
botName :: Text
The name of the bot. The bot name must be unique in the account that creates the bot.
roleArn :: Text
The Amazon Resource Name (ARN) of an IAM role that has permission 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 CreateBot Source #
Instance details Defined in Amazonka.LexV2Models.CreateBot Methods toJSON :: CreateBot -> Value # toEncoding :: CreateBot -> Encoding # toJSONList :: [CreateBot] -> Value # toEncodingList :: [CreateBot] -> Encoding #
ToHeaders CreateBot Source #
Instance details Defined in Amazonka.LexV2Models.CreateBot Methods toHeaders :: CreateBot -> [Header] #
ToPath CreateBot Source #
Instance details Defined in Amazonka.LexV2Models.CreateBot Methods toPath :: CreateBot -> ByteString #
ToQuery CreateBot Source #
Instance details Defined in Amazonka.LexV2Models.CreateBot Methods toQuery :: CreateBot -> QueryString #
AWSRequest CreateBot Source #
Instance details Defined in Amazonka.LexV2Models.CreateBot Associated Types type AWSResponse CreateBot # Methods request :: (Service -> Service) -> CreateBot -> Request CreateBot # response :: MonadResource m => (ByteStringLazy -> IO ByteStringLazy) -> Service -> Proxy CreateBot -> ClientResponse ClientBody -> m (Either Error (ClientResponse (AWSResponse CreateBot))) #
Generic CreateBot Source #
Instance details Defined in Amazonka.LexV2Models.CreateBot Associated Types type Rep CreateBot :: Type -> Type # Methods from :: CreateBot -> Rep CreateBot x # to :: Rep CreateBot x -> CreateBot #
Read CreateBot Source #
Instance details Defined in Amazonka.LexV2Models.CreateBot Methods readsPrec :: Int -> ReadS CreateBot # readList :: ReadS [CreateBot] # readPrec :: ReadPrec CreateBot # readListPrec :: ReadPrec [CreateBot] #
Show CreateBot Source #
Instance details Defined in Amazonka.LexV2Models.CreateBot Methods showsPrec :: Int -> CreateBot -> ShowS # show :: CreateBot -> String # showList :: [CreateBot] -> ShowS #
NFData CreateBot Source #
Instance details Defined in Amazonka.LexV2Models.CreateBot Methods rnf :: CreateBot -> () #
Eq CreateBot Source #
Instance details Defined in Amazonka.LexV2Models.CreateBot Methods (==) :: CreateBot -> CreateBot -> Bool # (/=) :: CreateBot -> CreateBot -> Bool #
Hashable CreateBot Source #
Instance details Defined in Amazonka.LexV2Models.CreateBot Methods hashWithSalt :: Int -> CreateBot -> Int # hash :: CreateBot -> Int #
type AWSResponse CreateBot Source #
Instance details Defined in Amazonka.LexV2Models.CreateBot type AWSResponse CreateBot = CreateBotResponse
type Rep CreateBot Source #
Instance details Defined in Amazonka.LexV2Models.CreateBot type Rep CreateBot = D1 ('MetaData "CreateBot" "Amazonka.LexV2Models.CreateBot" "amazonka-lexv2-models-2.0-5mExjJXBfuO6j0ascNcayE" 'False) (C1 ('MetaCons "CreateBot'" 'PrefixI 'True) ((S1 ('MetaSel ('Just "botTags") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe (HashMap Text Text))) :: (S1 ('MetaSel ('Just "description") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :: S1 ('MetaSel ('Just "testBotAliasTags") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe (HashMap Text 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)))))

newCreateBot Source #

Arguments

:: Text	`CreateBot`
-> Text	`CreateBot`
-> DataPrivacy	`CreateBot`
-> Natural	`CreateBot`
-> CreateBot

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

CreateBot, createBot_botTags - A list of tags to add to the bot. You can only add tags when you create a bot. You can't use the UpdateBot operation to update tags. To update tags, use the TagResource operation.

CreateBot, createBot_description - A description of the bot. It appears in lists to help you identify a particular bot.

CreateBot, createBot_testBotAliasTags - A list of tags to add to the test alias for a bot. You can only add tags when you create a bot. You can't use the UpdateAlias operation to update tags. To update tags on the test alias, use the TagResource operation.

CreateBot, createBot_botName - The name of the bot. The bot name must be unique in the account that creates the bot.

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

CreateBot, createBot_dataPrivacy - Provides information on additional privacy protections Amazon Lex should use with the bot's data.

CreateBot, createBot_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

createBot_botTags :: Lens' CreateBot (Maybe (HashMap Text Text)) Source #

A list of tags to add to the bot. You can only add tags when you create a bot. You can't use the UpdateBot operation to update tags. To update tags, use the TagResource operation.

createBot_description :: Lens' CreateBot (Maybe Text) Source #

A description of the bot. It appears in lists to help you identify a particular bot.

createBot_testBotAliasTags :: Lens' CreateBot (Maybe (HashMap Text Text)) Source #

A list of tags to add to the test alias for a bot. You can only add tags when you create a bot. You can't use the UpdateAlias operation to update tags. To update tags on the test alias, use the TagResource operation.

createBot_botName :: Lens' CreateBot Text Source #

The name of the bot. The bot name must be unique in the account that creates the bot.

createBot_roleArn :: Lens' CreateBot Text Source #

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

createBot_dataPrivacy :: Lens' CreateBot DataPrivacy Source #

Provides information on additional privacy protections Amazon Lex should use with the bot's data.

createBot_idleSessionTTLInSeconds :: Lens' CreateBot 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 CreateBotResponse Source #

See: newCreateBotResponse smart constructor.

Constructors

CreateBotResponse'

Fields

botId :: Maybe Text
A unique identifier for a particular bot. You use this to identify the bot when you call other Amazon Lex API operations.
botName :: Maybe Text
The name specified for the bot.
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.
botTags :: Maybe (HashMap Text Text)
A list of tags associated with the bot.
creationDateTime :: Maybe POSIX
A timestamp indicating the date and time that the bot was created.
dataPrivacy :: Maybe DataPrivacy
The data privacy settings specified for the bot.
description :: Maybe Text
The description specified for the bot.
idleSessionTTLInSeconds :: Maybe Natural
The session idle time specified for the bot.
roleArn :: Maybe Text
The IAM role specified for the bot.
testBotAliasTags :: Maybe (HashMap Text Text)
A list of tags associated with the test alias for the bot.
httpStatus :: Int
The response's http status code.

Instances

Instances details

Generic CreateBotResponse Source #
Instance details Defined in Amazonka.LexV2Models.CreateBot Associated Types type Rep CreateBotResponse :: Type -> Type # Methods from :: CreateBotResponse -> Rep CreateBotResponse x # to :: Rep CreateBotResponse x -> CreateBotResponse #
Read CreateBotResponse Source #
Instance details Defined in Amazonka.LexV2Models.CreateBot Methods readsPrec :: Int -> ReadS CreateBotResponse # readList :: ReadS [CreateBotResponse] # readPrec :: ReadPrec CreateBotResponse # readListPrec :: ReadPrec [CreateBotResponse] #
Show CreateBotResponse Source #
Instance details Defined in Amazonka.LexV2Models.CreateBot Methods showsPrec :: Int -> CreateBotResponse -> ShowS # show :: CreateBotResponse -> String # showList :: [CreateBotResponse] -> ShowS #
NFData CreateBotResponse Source #
Instance details Defined in Amazonka.LexV2Models.CreateBot Methods rnf :: CreateBotResponse -> () #
Eq CreateBotResponse Source #
Instance details Defined in Amazonka.LexV2Models.CreateBot Methods (==) :: CreateBotResponse -> CreateBotResponse -> Bool # (/=) :: CreateBotResponse -> CreateBotResponse -> Bool #
type Rep CreateBotResponse Source #
Instance details Defined in Amazonka.LexV2Models.CreateBot type Rep CreateBotResponse = D1 ('MetaData "CreateBotResponse" "Amazonka.LexV2Models.CreateBot" "amazonka-lexv2-models-2.0-5mExjJXBfuO6j0ascNcayE" 'False) (C1 ('MetaCons "CreateBotResponse'" '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 "botTags") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe (HashMap Text Text))) :: 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 "roleArn") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :: (S1 ('MetaSel ('Just "testBotAliasTags") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe (HashMap Text Text))) :: S1 ('MetaSel ('Just "httpStatus") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Int))))))

newCreateBotResponse Source #

Arguments

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

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

CreateBotResponse, createBotResponse_botId - A unique identifier for a particular bot. You use this to identify the bot when you call other Amazon Lex API operations.

CreateBot, createBotResponse_botName - The name specified for the bot.

CreateBotResponse, createBotResponse_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.

CreateBot, createBotResponse_botTags - A list of tags associated with the bot.

CreateBotResponse, createBotResponse_creationDateTime - A timestamp indicating the date and time that the bot was created.

CreateBot, createBotResponse_dataPrivacy - The data privacy settings specified for the bot.

CreateBot, createBotResponse_description - The description specified for the bot.

CreateBot, createBotResponse_idleSessionTTLInSeconds - The session idle time specified for the bot.

CreateBot, createBotResponse_roleArn - The IAM role specified for the bot.

CreateBot, createBotResponse_testBotAliasTags - A list of tags associated with the test alias for the bot.

$sel:httpStatus:CreateBotResponse', createBotResponse_httpStatus - The response's http status code.

Response Lenses

createBotResponse_botId :: Lens' CreateBotResponse (Maybe Text) Source #

A unique identifier for a particular bot. You use this to identify the bot when you call other Amazon Lex API operations.

createBotResponse_botName :: Lens' CreateBotResponse (Maybe Text) Source #

The name specified for the bot.

createBotResponse_botStatus :: Lens' CreateBotResponse (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.

createBotResponse_botTags :: Lens' CreateBotResponse (Maybe (HashMap Text Text)) Source #

A list of tags associated with the bot.

createBotResponse_creationDateTime :: Lens' CreateBotResponse (Maybe UTCTime) Source #

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

createBotResponse_dataPrivacy :: Lens' CreateBotResponse (Maybe DataPrivacy) Source #

The data privacy settings specified for the bot.

createBotResponse_description :: Lens' CreateBotResponse (Maybe Text) Source #

The description specified for the bot.

createBotResponse_idleSessionTTLInSeconds :: Lens' CreateBotResponse (Maybe Natural) Source #

The session idle time specified for the bot.

createBotResponse_roleArn :: Lens' CreateBotResponse (Maybe Text) Source #

The IAM role specified for the bot.

createBotResponse_testBotAliasTags :: Lens' CreateBotResponse (Maybe (HashMap Text Text)) Source #

A list of tags associated with the test alias for the bot.

createBotResponse_httpStatus :: Lens' CreateBotResponse Int Source #

The response's http status code.