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

Contents

Creating a Request
Request Lenses
Destructuring the Response
Response Lenses

Description

Creates an alias for the specified version of a bot. Use an alias to enable you to change the version of a bot without updating applications that use the bot.

For example, you can create an alias called "PROD" that your applications use to call the Amazon Lex bot.

Synopsis

data CreateBotAlias = CreateBotAlias' {
- botAliasLocaleSettings :: Maybe (HashMap Text BotAliasLocaleSettings)
- botVersion :: Maybe Text
- conversationLogSettings :: Maybe ConversationLogSettings
- description :: Maybe Text
- sentimentAnalysisSettings :: Maybe SentimentAnalysisSettings
- tags :: Maybe (HashMap Text Text)
- botAliasName :: Text
- botId :: Text
}
newCreateBotAlias :: Text -> Text -> CreateBotAlias
createBotAlias_botAliasLocaleSettings :: Lens' CreateBotAlias (Maybe (HashMap Text BotAliasLocaleSettings))
createBotAlias_botVersion :: Lens' CreateBotAlias (Maybe Text)
createBotAlias_conversationLogSettings :: Lens' CreateBotAlias (Maybe ConversationLogSettings)
createBotAlias_description :: Lens' CreateBotAlias (Maybe Text)
createBotAlias_sentimentAnalysisSettings :: Lens' CreateBotAlias (Maybe SentimentAnalysisSettings)
createBotAlias_tags :: Lens' CreateBotAlias (Maybe (HashMap Text Text))
createBotAlias_botAliasName :: Lens' CreateBotAlias Text
createBotAlias_botId :: Lens' CreateBotAlias Text
data CreateBotAliasResponse = CreateBotAliasResponse' {
- botAliasId :: Maybe Text
- botAliasLocaleSettings :: Maybe (HashMap Text BotAliasLocaleSettings)
- botAliasName :: Maybe Text
- botAliasStatus :: Maybe BotAliasStatus
- botId :: Maybe Text
- botVersion :: Maybe Text
- conversationLogSettings :: Maybe ConversationLogSettings
- creationDateTime :: Maybe POSIX
- description :: Maybe Text
- sentimentAnalysisSettings :: Maybe SentimentAnalysisSettings
- tags :: Maybe (HashMap Text Text)
- httpStatus :: Int
}
newCreateBotAliasResponse :: Int -> CreateBotAliasResponse
createBotAliasResponse_botAliasId :: Lens' CreateBotAliasResponse (Maybe Text)
createBotAliasResponse_botAliasLocaleSettings :: Lens' CreateBotAliasResponse (Maybe (HashMap Text BotAliasLocaleSettings))
createBotAliasResponse_botAliasName :: Lens' CreateBotAliasResponse (Maybe Text)
createBotAliasResponse_botAliasStatus :: Lens' CreateBotAliasResponse (Maybe BotAliasStatus)
createBotAliasResponse_botId :: Lens' CreateBotAliasResponse (Maybe Text)
createBotAliasResponse_botVersion :: Lens' CreateBotAliasResponse (Maybe Text)
createBotAliasResponse_conversationLogSettings :: Lens' CreateBotAliasResponse (Maybe ConversationLogSettings)
createBotAliasResponse_creationDateTime :: Lens' CreateBotAliasResponse (Maybe UTCTime)
createBotAliasResponse_description :: Lens' CreateBotAliasResponse (Maybe Text)
createBotAliasResponse_sentimentAnalysisSettings :: Lens' CreateBotAliasResponse (Maybe SentimentAnalysisSettings)
createBotAliasResponse_tags :: Lens' CreateBotAliasResponse (Maybe (HashMap Text Text))
createBotAliasResponse_httpStatus :: Lens' CreateBotAliasResponse Int

Creating a Request

data CreateBotAlias Source #

See: newCreateBotAlias smart constructor.

Constructors

CreateBotAlias'

Fields

botAliasLocaleSettings :: Maybe (HashMap Text BotAliasLocaleSettings)
Maps configuration information to a specific locale. You can use this parameter to specify a specific Lambda function to run different functions in different locales.
botVersion :: Maybe Text
The version of the bot that this alias points to. You can use the UpdateBotAlias operation to change the bot version associated with the alias.
conversationLogSettings :: Maybe ConversationLogSettings
Specifies whether Amazon Lex logs text and audio for a conversation with the bot. When you enable conversation logs, text logs store text input, transcripts of audio input, and associated metadata in Amazon CloudWatch Logs. Audio logs store audio input in Amazon S3.
description :: Maybe Text
A description of the alias. Use this description to help identify the alias.
sentimentAnalysisSettings :: Maybe SentimentAnalysisSettings
tags :: Maybe (HashMap Text Text)
A list of tags to add to the bot alias. You can only add tags when you create an alias, you can't use the UpdateBotAlias operation to update the tags on a bot alias. To update tags, use the TagResource operation.
botAliasName :: Text
The alias to create. The name must be unique for the bot.
botId :: Text
The unique identifier of the bot that the alias applies to.

Instances

Instances details

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

newCreateBotAlias Source #

Arguments

:: Text	`CreateBotAlias`
-> Text	`CreateBotAlias`
-> CreateBotAlias

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

CreateBotAlias, createBotAlias_botAliasLocaleSettings - Maps configuration information to a specific locale. You can use this parameter to specify a specific Lambda function to run different functions in different locales.

CreateBotAlias, createBotAlias_botVersion - The version of the bot that this alias points to. You can use the UpdateBotAlias operation to change the bot version associated with the alias.

CreateBotAlias, createBotAlias_conversationLogSettings - Specifies whether Amazon Lex logs text and audio for a conversation with the bot. When you enable conversation logs, text logs store text input, transcripts of audio input, and associated metadata in Amazon CloudWatch Logs. Audio logs store audio input in Amazon S3.

CreateBotAlias, createBotAlias_description - A description of the alias. Use this description to help identify the alias.

CreateBotAlias, createBotAlias_sentimentAnalysisSettings - Undocumented member.

CreateBotAlias, createBotAlias_tags - A list of tags to add to the bot alias. You can only add tags when you create an alias, you can't use the UpdateBotAlias operation to update the tags on a bot alias. To update tags, use the TagResource operation.

CreateBotAlias, createBotAlias_botAliasName - The alias to create. The name must be unique for the bot.

CreateBotAlias, createBotAlias_botId - The unique identifier of the bot that the alias applies to.

Request Lenses

createBotAlias_botAliasLocaleSettings :: Lens' CreateBotAlias (Maybe (HashMap Text BotAliasLocaleSettings)) Source #

Maps configuration information to a specific locale. You can use this parameter to specify a specific Lambda function to run different functions in different locales.

createBotAlias_botVersion :: Lens' CreateBotAlias (Maybe Text) Source #

The version of the bot that this alias points to. You can use the UpdateBotAlias operation to change the bot version associated with the alias.

createBotAlias_conversationLogSettings :: Lens' CreateBotAlias (Maybe ConversationLogSettings) Source #

Specifies whether Amazon Lex logs text and audio for a conversation with the bot. When you enable conversation logs, text logs store text input, transcripts of audio input, and associated metadata in Amazon CloudWatch Logs. Audio logs store audio input in Amazon S3.

createBotAlias_description :: Lens' CreateBotAlias (Maybe Text) Source #

A description of the alias. Use this description to help identify the alias.

createBotAlias_sentimentAnalysisSettings :: Lens' CreateBotAlias (Maybe SentimentAnalysisSettings) Source #

Undocumented member.

createBotAlias_tags :: Lens' CreateBotAlias (Maybe (HashMap Text Text)) Source #

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

createBotAlias_botAliasName :: Lens' CreateBotAlias Text Source #

The alias to create. The name must be unique for the bot.

createBotAlias_botId :: Lens' CreateBotAlias Text Source #

The unique identifier of the bot that the alias applies to.

Destructuring the Response

data CreateBotAliasResponse Source #

See: newCreateBotAliasResponse smart constructor.

Constructors

CreateBotAliasResponse'

Fields

botAliasId :: Maybe Text
The unique identifier of the bot alias.
botAliasLocaleSettings :: Maybe (HashMap Text BotAliasLocaleSettings)
Configuration information for a specific locale.
botAliasName :: Maybe Text
The name specified for the bot alias.
botAliasStatus :: Maybe BotAliasStatus
The current status of the alias. The alias is first put into the Creating state. When the alias is ready to be used, it is put into the Available state. You can use the DescribeBotAlias operation to get the current state of an alias.
botId :: Maybe Text
The unique identifier of the bot that this alias applies to.
botVersion :: Maybe Text
The version of the bot associated with this alias.
conversationLogSettings :: Maybe ConversationLogSettings
The conversation log settings specified for the alias.
creationDateTime :: Maybe POSIX
A Unix timestamp indicating the date and time that the bot alias was created.
description :: Maybe Text
The description specified for the bot alias.
sentimentAnalysisSettings :: Maybe SentimentAnalysisSettings
tags :: Maybe (HashMap Text Text)
A list of tags associated with the bot alias.
httpStatus :: Int
The response's http status code.

Instances

Instances details

Generic CreateBotAliasResponse Source #
Instance details Defined in Amazonka.LexV2Models.CreateBotAlias Associated Types type Rep CreateBotAliasResponse :: Type -> Type # Methods from :: CreateBotAliasResponse -> Rep CreateBotAliasResponse x # to :: Rep CreateBotAliasResponse x -> CreateBotAliasResponse #
Read CreateBotAliasResponse Source #
Instance details Defined in Amazonka.LexV2Models.CreateBotAlias Methods readsPrec :: Int -> ReadS CreateBotAliasResponse # readList :: ReadS [CreateBotAliasResponse] # readPrec :: ReadPrec CreateBotAliasResponse # readListPrec :: ReadPrec [CreateBotAliasResponse] #
Show CreateBotAliasResponse Source #
Instance details Defined in Amazonka.LexV2Models.CreateBotAlias Methods showsPrec :: Int -> CreateBotAliasResponse -> ShowS # show :: CreateBotAliasResponse -> String # showList :: [CreateBotAliasResponse] -> ShowS #
NFData CreateBotAliasResponse Source #
Instance details Defined in Amazonka.LexV2Models.CreateBotAlias Methods rnf :: CreateBotAliasResponse -> () #
Eq CreateBotAliasResponse Source #
Instance details Defined in Amazonka.LexV2Models.CreateBotAlias Methods (==) :: CreateBotAliasResponse -> CreateBotAliasResponse -> Bool # (/=) :: CreateBotAliasResponse -> CreateBotAliasResponse -> Bool #
type Rep CreateBotAliasResponse Source #
Instance details Defined in Amazonka.LexV2Models.CreateBotAlias type Rep CreateBotAliasResponse = D1 ('MetaData "CreateBotAliasResponse" "Amazonka.LexV2Models.CreateBotAlias" "amazonka-lexv2-models-2.0-5mExjJXBfuO6j0ascNcayE" 'False) (C1 ('MetaCons "CreateBotAliasResponse'" 'PrefixI 'True) (((S1 ('MetaSel ('Just "botAliasId") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :: (S1 ('MetaSel ('Just "botAliasLocaleSettings") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe (HashMap Text BotAliasLocaleSettings))) :: S1 ('MetaSel ('Just "botAliasName") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)))) :: (S1 ('MetaSel ('Just "botAliasStatus") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe BotAliasStatus)) :: (S1 ('MetaSel ('Just "botId") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :: S1 ('MetaSel ('Just "botVersion") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text))))) :: ((S1 ('MetaSel ('Just "conversationLogSettings") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe ConversationLogSettings)) :: (S1 ('MetaSel ('Just "creationDateTime") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe POSIX)) :: S1 ('MetaSel ('Just "description") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)))) :: (S1 ('MetaSel ('Just "sentimentAnalysisSettings") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe SentimentAnalysisSettings)) :: (S1 ('MetaSel ('Just "tags") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe (HashMap Text Text))) :*: S1 ('MetaSel ('Just "httpStatus") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Int))))))

newCreateBotAliasResponse Source #

Arguments

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

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

CreateBotAliasResponse, createBotAliasResponse_botAliasId - The unique identifier of the bot alias.

CreateBotAlias, createBotAliasResponse_botAliasLocaleSettings - Configuration information for a specific locale.

CreateBotAlias, createBotAliasResponse_botAliasName - The name specified for the bot alias.

CreateBotAliasResponse, createBotAliasResponse_botAliasStatus - The current status of the alias. The alias is first put into the Creating state. When the alias is ready to be used, it is put into the Available state. You can use the DescribeBotAlias operation to get the current state of an alias.

CreateBotAlias, createBotAliasResponse_botId - The unique identifier of the bot that this alias applies to.

CreateBotAlias, createBotAliasResponse_botVersion - The version of the bot associated with this alias.

CreateBotAlias, createBotAliasResponse_conversationLogSettings - The conversation log settings specified for the alias.

CreateBotAliasResponse, createBotAliasResponse_creationDateTime - A Unix timestamp indicating the date and time that the bot alias was created.

CreateBotAlias, createBotAliasResponse_description - The description specified for the bot alias.

CreateBotAlias, createBotAliasResponse_sentimentAnalysisSettings - Undocumented member.

CreateBotAlias, createBotAliasResponse_tags - A list of tags associated with the bot alias.

$sel:httpStatus:CreateBotAliasResponse', createBotAliasResponse_httpStatus - The response's http status code.

Response Lenses

createBotAliasResponse_botAliasId :: Lens' CreateBotAliasResponse (Maybe Text) Source #

The unique identifier of the bot alias.

createBotAliasResponse_botAliasLocaleSettings :: Lens' CreateBotAliasResponse (Maybe (HashMap Text BotAliasLocaleSettings)) Source #

Configuration information for a specific locale.

createBotAliasResponse_botAliasName :: Lens' CreateBotAliasResponse (Maybe Text) Source #

The name specified for the bot alias.

createBotAliasResponse_botAliasStatus :: Lens' CreateBotAliasResponse (Maybe BotAliasStatus) Source #

The current status of the alias. The alias is first put into the Creating state. When the alias is ready to be used, it is put into the Available state. You can use the DescribeBotAlias operation to get the current state of an alias.

createBotAliasResponse_botId :: Lens' CreateBotAliasResponse (Maybe Text) Source #

The unique identifier of the bot that this alias applies to.

createBotAliasResponse_botVersion :: Lens' CreateBotAliasResponse (Maybe Text) Source #

The version of the bot associated with this alias.

createBotAliasResponse_conversationLogSettings :: Lens' CreateBotAliasResponse (Maybe ConversationLogSettings) Source #

The conversation log settings specified for the alias.

createBotAliasResponse_creationDateTime :: Lens' CreateBotAliasResponse (Maybe UTCTime) Source #

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

createBotAliasResponse_description :: Lens' CreateBotAliasResponse (Maybe Text) Source #

The description specified for the bot alias.

createBotAliasResponse_sentimentAnalysisSettings :: Lens' CreateBotAliasResponse (Maybe SentimentAnalysisSettings) Source #

Undocumented member.

createBotAliasResponse_tags :: Lens' CreateBotAliasResponse (Maybe (HashMap Text Text)) Source #

A list of tags associated with the bot alias.

createBotAliasResponse_httpStatus :: Lens' CreateBotAliasResponse Int Source #

The response's http status code.