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 a new version of the bot based on the $LATEST
version. If the
$LATEST
version of this resource hasn't changed since you created the
last version, Amazon Lex doesn't create a new version. It returns the
last created version.
You can update only the $LATEST
version of the bot. You can't update
the numbered versions that you create with the CreateBotVersion
operation.
When you create the first version of a bot, Amazon Lex sets the version to 1. Subsequent versions increment by 1. For more information, see versioning-intro.
This operation requires permission for the lex:CreateBotVersion
action.
Synopsis
- data CreateBotVersion = CreateBotVersion' {}
- newCreateBotVersion :: Text -> CreateBotVersion
- createBotVersion_checksum :: Lens' CreateBotVersion (Maybe Text)
- createBotVersion_name :: Lens' CreateBotVersion Text
- data CreateBotVersionResponse = CreateBotVersionResponse' {
- abortStatement :: Maybe Statement
- checksum :: Maybe Text
- childDirected :: Maybe Bool
- clarificationPrompt :: Maybe Prompt
- createdDate :: Maybe POSIX
- description :: Maybe Text
- detectSentiment :: Maybe Bool
- enableModelImprovements :: Maybe Bool
- failureReason :: Maybe Text
- idleSessionTTLInSeconds :: Maybe Natural
- intents :: Maybe [Intent]
- lastUpdatedDate :: Maybe POSIX
- locale :: Maybe Locale
- name :: Maybe Text
- status :: Maybe LexStatus
- version :: Maybe Text
- voiceId :: Maybe Text
- httpStatus :: Int
- newCreateBotVersionResponse :: Int -> CreateBotVersionResponse
- createBotVersionResponse_abortStatement :: Lens' CreateBotVersionResponse (Maybe Statement)
- createBotVersionResponse_checksum :: Lens' CreateBotVersionResponse (Maybe Text)
- createBotVersionResponse_childDirected :: Lens' CreateBotVersionResponse (Maybe Bool)
- createBotVersionResponse_clarificationPrompt :: Lens' CreateBotVersionResponse (Maybe Prompt)
- createBotVersionResponse_createdDate :: Lens' CreateBotVersionResponse (Maybe UTCTime)
- createBotVersionResponse_description :: Lens' CreateBotVersionResponse (Maybe Text)
- createBotVersionResponse_detectSentiment :: Lens' CreateBotVersionResponse (Maybe Bool)
- createBotVersionResponse_enableModelImprovements :: Lens' CreateBotVersionResponse (Maybe Bool)
- createBotVersionResponse_failureReason :: Lens' CreateBotVersionResponse (Maybe Text)
- createBotVersionResponse_idleSessionTTLInSeconds :: Lens' CreateBotVersionResponse (Maybe Natural)
- createBotVersionResponse_intents :: Lens' CreateBotVersionResponse (Maybe [Intent])
- createBotVersionResponse_lastUpdatedDate :: Lens' CreateBotVersionResponse (Maybe UTCTime)
- createBotVersionResponse_locale :: Lens' CreateBotVersionResponse (Maybe Locale)
- createBotVersionResponse_name :: Lens' CreateBotVersionResponse (Maybe Text)
- createBotVersionResponse_status :: Lens' CreateBotVersionResponse (Maybe LexStatus)
- createBotVersionResponse_version :: Lens' CreateBotVersionResponse (Maybe Text)
- createBotVersionResponse_voiceId :: Lens' CreateBotVersionResponse (Maybe Text)
- createBotVersionResponse_httpStatus :: Lens' CreateBotVersionResponse Int
Creating a Request
data CreateBotVersion Source #
See: newCreateBotVersion
smart constructor.
CreateBotVersion' | |
|
Instances
Create a value of CreateBotVersion
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:
CreateBotVersion
, createBotVersion_checksum
- Identifies a specific revision of the $LATEST
version of the bot. If
you specify a checksum and the $LATEST
version of the bot has a
different checksum, a PreconditionFailedException
exception is
returned and Amazon Lex doesn't publish a new version. If you don't
specify a checksum, Amazon Lex publishes the $LATEST
version.
CreateBotVersion
, createBotVersion_name
- The name of the bot that you want to create a new version of. The name
is case sensitive.
Request Lenses
createBotVersion_checksum :: Lens' CreateBotVersion (Maybe Text) Source #
Identifies a specific revision of the $LATEST
version of the bot. If
you specify a checksum and the $LATEST
version of the bot has a
different checksum, a PreconditionFailedException
exception is
returned and Amazon Lex doesn't publish a new version. If you don't
specify a checksum, Amazon Lex publishes the $LATEST
version.
createBotVersion_name :: Lens' CreateBotVersion Text Source #
The name of the bot that you want to create a new version of. The name is case sensitive.
Destructuring the Response
data CreateBotVersionResponse Source #
See: newCreateBotVersionResponse
smart constructor.
CreateBotVersionResponse' | |
|
Instances
newCreateBotVersionResponse Source #
Create a value of CreateBotVersionResponse
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:
$sel:abortStatement:CreateBotVersionResponse'
, createBotVersionResponse_abortStatement
- The message that Amazon Lex uses to cancel a conversation. For more
information, see PutBot.
CreateBotVersion
, createBotVersionResponse_checksum
- Checksum identifying the version of the bot that was created.
$sel:childDirected:CreateBotVersionResponse'
, createBotVersionResponse_childDirected
- For each Amazon Lex bot created with the Amazon Lex Model Building
Service, you must specify whether your use of Amazon Lex is related to a
website, program, or other application that is directed or targeted, in
whole or in part, to children under age 13 and subject to the
Children's Online Privacy Protection Act (COPPA) by specifying true
or false
in the childDirected
field. By specifying true
in the
childDirected
field, you confirm that your use of Amazon Lex is
related to a website, program, or other application that is directed or
targeted, in whole or in part, to children under age 13 and subject to
COPPA. By specifying false
in the childDirected
field, you confirm
that your use of Amazon Lex is not related to a website, program, or
other application that is directed or targeted, in whole or in part, to
children under age 13 and subject to COPPA. You may not specify a
default value for the childDirected
field that does not accurately
reflect whether your use of Amazon Lex is related to a website, program,
or other application that is directed or targeted, in whole or in part,
to children under age 13 and subject to COPPA.
If your use of Amazon Lex relates to a website, program, or other application that is directed in whole or in part, to children under age 13, you must obtain any required verifiable parental consent under COPPA. For information regarding the use of Amazon Lex in connection with websites, programs, or other applications that are directed or targeted, in whole or in part, to children under age 13, see the Amazon Lex FAQ.
$sel:clarificationPrompt:CreateBotVersionResponse'
, createBotVersionResponse_clarificationPrompt
- The message that Amazon Lex uses when it doesn't understand the user's
request. For more information, see PutBot.
CreateBotVersionResponse
, createBotVersionResponse_createdDate
- The date when the bot version was created.
CreateBotVersionResponse
, createBotVersionResponse_description
- A description of the bot.
$sel:detectSentiment:CreateBotVersionResponse'
, createBotVersionResponse_detectSentiment
- Indicates whether utterances entered by the user should be sent to
Amazon Comprehend for sentiment analysis.
$sel:enableModelImprovements:CreateBotVersionResponse'
, createBotVersionResponse_enableModelImprovements
- Indicates whether the bot uses accuracy improvements. true
indicates
that the bot is using the improvements, otherwise, false
.
CreateBotVersionResponse
, createBotVersionResponse_failureReason
- If status
is FAILED
, Amazon Lex provides the reason that it failed
to build the bot.
$sel:idleSessionTTLInSeconds:CreateBotVersionResponse'
, createBotVersionResponse_idleSessionTTLInSeconds
- The maximum time in seconds that Amazon Lex retains the data gathered in
a conversation. For more information, see PutBot.
$sel:intents:CreateBotVersionResponse'
, createBotVersionResponse_intents
- An array of Intent
objects. For more information, see PutBot.
CreateBotVersionResponse
, createBotVersionResponse_lastUpdatedDate
- The date when the $LATEST
version of this bot was updated.
$sel:locale:CreateBotVersionResponse'
, createBotVersionResponse_locale
- Specifies the target locale for the bot.
CreateBotVersion
, createBotVersionResponse_name
- The name of the bot.
CreateBotVersionResponse
, createBotVersionResponse_status
- When you send a request to create or update a bot, Amazon Lex sets the
status
response element to BUILDING
. After Amazon Lex builds the
bot, it sets status
to READY
. If Amazon Lex can't build the bot, it
sets status
to FAILED
. Amazon Lex returns the reason for the failure
in the failureReason
response element.
CreateBotVersionResponse
, createBotVersionResponse_version
- The version of the bot.
$sel:voiceId:CreateBotVersionResponse'
, createBotVersionResponse_voiceId
- The Amazon Polly voice ID that Amazon Lex uses for voice interactions
with the user.
$sel:httpStatus:CreateBotVersionResponse'
, createBotVersionResponse_httpStatus
- The response's http status code.
Response Lenses
createBotVersionResponse_abortStatement :: Lens' CreateBotVersionResponse (Maybe Statement) Source #
The message that Amazon Lex uses to cancel a conversation. For more information, see PutBot.
createBotVersionResponse_checksum :: Lens' CreateBotVersionResponse (Maybe Text) Source #
Checksum identifying the version of the bot that was created.
createBotVersionResponse_childDirected :: Lens' CreateBotVersionResponse (Maybe Bool) Source #
For each Amazon Lex bot created with the Amazon Lex Model Building
Service, you must specify whether your use of Amazon Lex is related to a
website, program, or other application that is directed or targeted, in
whole or in part, to children under age 13 and subject to the
Children's Online Privacy Protection Act (COPPA) by specifying true
or false
in the childDirected
field. By specifying true
in the
childDirected
field, you confirm that your use of Amazon Lex is
related to a website, program, or other application that is directed or
targeted, in whole or in part, to children under age 13 and subject to
COPPA. By specifying false
in the childDirected
field, you confirm
that your use of Amazon Lex is not related to a website, program, or
other application that is directed or targeted, in whole or in part, to
children under age 13 and subject to COPPA. You may not specify a
default value for the childDirected
field that does not accurately
reflect whether your use of Amazon Lex is related to a website, program,
or other application that is directed or targeted, in whole or in part,
to children under age 13 and subject to COPPA.
If your use of Amazon Lex relates to a website, program, or other application that is directed in whole or in part, to children under age 13, you must obtain any required verifiable parental consent under COPPA. For information regarding the use of Amazon Lex in connection with websites, programs, or other applications that are directed or targeted, in whole or in part, to children under age 13, see the Amazon Lex FAQ.
createBotVersionResponse_clarificationPrompt :: Lens' CreateBotVersionResponse (Maybe Prompt) Source #
The message that Amazon Lex uses when it doesn't understand the user's request. For more information, see PutBot.
createBotVersionResponse_createdDate :: Lens' CreateBotVersionResponse (Maybe UTCTime) Source #
The date when the bot version was created.
createBotVersionResponse_description :: Lens' CreateBotVersionResponse (Maybe Text) Source #
A description of the bot.
createBotVersionResponse_detectSentiment :: Lens' CreateBotVersionResponse (Maybe Bool) Source #
Indicates whether utterances entered by the user should be sent to Amazon Comprehend for sentiment analysis.
createBotVersionResponse_enableModelImprovements :: Lens' CreateBotVersionResponse (Maybe Bool) Source #
Indicates whether the bot uses accuracy improvements. true
indicates
that the bot is using the improvements, otherwise, false
.
createBotVersionResponse_failureReason :: Lens' CreateBotVersionResponse (Maybe Text) Source #
If status
is FAILED
, Amazon Lex provides the reason that it failed
to build the bot.
createBotVersionResponse_idleSessionTTLInSeconds :: Lens' CreateBotVersionResponse (Maybe Natural) Source #
The maximum time in seconds that Amazon Lex retains the data gathered in a conversation. For more information, see PutBot.
createBotVersionResponse_intents :: Lens' CreateBotVersionResponse (Maybe [Intent]) Source #
An array of Intent
objects. For more information, see PutBot.
createBotVersionResponse_lastUpdatedDate :: Lens' CreateBotVersionResponse (Maybe UTCTime) Source #
The date when the $LATEST
version of this bot was updated.
createBotVersionResponse_locale :: Lens' CreateBotVersionResponse (Maybe Locale) Source #
Specifies the target locale for the bot.
createBotVersionResponse_name :: Lens' CreateBotVersionResponse (Maybe Text) Source #
The name of the bot.
createBotVersionResponse_status :: Lens' CreateBotVersionResponse (Maybe LexStatus) Source #
When you send a request to create or update a bot, Amazon Lex sets the
status
response element to BUILDING
. After Amazon Lex builds the
bot, it sets status
to READY
. If Amazon Lex can't build the bot, it
sets status
to FAILED
. Amazon Lex returns the reason for the failure
in the failureReason
response element.
createBotVersionResponse_version :: Lens' CreateBotVersionResponse (Maybe Text) Source #
The version of the bot.
createBotVersionResponse_voiceId :: Lens' CreateBotVersionResponse (Maybe Text) Source #
The Amazon Polly voice ID that Amazon Lex uses for voice interactions with the user.
createBotVersionResponse_httpStatus :: Lens' CreateBotVersionResponse Int Source #
The response's http status code.