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 |
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.
CreateBotAlias' | |
|
Instances
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.
CreateBotAliasResponse' | |
|
Instances
newCreateBotAliasResponse Source #
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.