Copyright	(c) 2013-2021 Brendan Hay
License	Mozilla Public License, v. 2.0.
Maintainer	Brendan Hay <brendan.g.hay+amazonka@gmail.com>
Stability	auto-generated
Portability	non-portable (GHC extensions)
Safe Haskell	None

Amazonka.LexModels.CreateBotVersion

Contents

Creating a Request
Request Lenses
Destructuring the Response
Response Lenses

Description

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

Creating a Request

data CreateBotVersion Source #

See: newCreateBotVersion smart constructor.

Constructors

CreateBotVersion'

Fields

checksum :: Maybe Text
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.
name :: Text
The name of the bot that you want to create a new version of. The name is case sensitive.

Instances

Instances details

Eq CreateBotVersion Source #
Instance details Defined in Amazonka.LexModels.CreateBotVersion Methods (==) :: CreateBotVersion -> CreateBotVersion -> Bool # (/=) :: CreateBotVersion -> CreateBotVersion -> Bool #
Read CreateBotVersion Source #
Instance details Defined in Amazonka.LexModels.CreateBotVersion Methods readsPrec :: Int -> ReadS CreateBotVersion # readList :: ReadS [CreateBotVersion] # readPrec :: ReadPrec CreateBotVersion # readListPrec :: ReadPrec [CreateBotVersion] #
Show CreateBotVersion Source #
Instance details Defined in Amazonka.LexModels.CreateBotVersion Methods showsPrec :: Int -> CreateBotVersion -> ShowS # show :: CreateBotVersion -> String # showList :: [CreateBotVersion] -> ShowS #
Generic CreateBotVersion Source #
Instance details Defined in Amazonka.LexModels.CreateBotVersion Associated Types type Rep CreateBotVersion :: Type -> Type # Methods from :: CreateBotVersion -> Rep CreateBotVersion x # to :: Rep CreateBotVersion x -> CreateBotVersion #
NFData CreateBotVersion Source #
Instance details Defined in Amazonka.LexModels.CreateBotVersion Methods rnf :: CreateBotVersion -> () #
Hashable CreateBotVersion Source #
Instance details Defined in Amazonka.LexModels.CreateBotVersion Methods hashWithSalt :: Int -> CreateBotVersion -> Int # hash :: CreateBotVersion -> Int #
ToJSON CreateBotVersion Source #
Instance details Defined in Amazonka.LexModels.CreateBotVersion Methods toJSON :: CreateBotVersion -> Value # toEncoding :: CreateBotVersion -> Encoding # toJSONList :: [CreateBotVersion] -> Value # toEncodingList :: [CreateBotVersion] -> Encoding #
AWSRequest CreateBotVersion Source #
Instance details Defined in Amazonka.LexModels.CreateBotVersion Associated Types type AWSResponse CreateBotVersion # Methods request :: CreateBotVersion -> Request CreateBotVersion # response :: MonadResource m => Logger -> Service -> Proxy CreateBotVersion -> ClientResponse ClientBody -> m (Either Error (ClientResponse (AWSResponse CreateBotVersion))) #
ToHeaders CreateBotVersion Source #
Instance details Defined in Amazonka.LexModels.CreateBotVersion Methods toHeaders :: CreateBotVersion -> [Header] #
ToPath CreateBotVersion Source #
Instance details Defined in Amazonka.LexModels.CreateBotVersion Methods toPath :: CreateBotVersion -> ByteString #
ToQuery CreateBotVersion Source #
Instance details Defined in Amazonka.LexModels.CreateBotVersion Methods toQuery :: CreateBotVersion -> QueryString #
type Rep CreateBotVersion Source #
Instance details Defined in Amazonka.LexModels.CreateBotVersion type Rep CreateBotVersion = D1 ('MetaData "CreateBotVersion" "Amazonka.LexModels.CreateBotVersion" "libZSservicesZSamazonka-lex-modelsZSamazonka-lex-models" 'False) (C1 ('MetaCons "CreateBotVersion'" 'PrefixI 'True) (S1 ('MetaSel ('Just "checksum") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :*: S1 ('MetaSel ('Just "name") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Text)))
type AWSResponse CreateBotVersion Source #
Instance details Defined in Amazonka.LexModels.CreateBotVersion type AWSResponse CreateBotVersion = CreateBotVersionResponse

newCreateBotVersion Source #

Arguments

:: Text	`$sel:name:CreateBotVersion'`
-> CreateBotVersion

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:

$sel:checksum: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.

$sel:name: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.

Constructors

CreateBotVersionResponse'

Fields

failureReason :: Maybe Text
If status is FAILED, Amazon Lex provides the reason that it failed to build the bot.
status :: Maybe LexStatus
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.
abortStatement :: Maybe Statement
The message that Amazon Lex uses to cancel a conversation. For more information, see PutBot.
intents :: Maybe [Intent]
An array of Intent objects. For more information, see PutBot.
checksum :: Maybe Text
Checksum identifying the version of the bot that was created.
enableModelImprovements :: Maybe Bool
Indicates whether the bot uses accuracy improvements. true indicates that the bot is using the improvements, otherwise, false.
detectSentiment :: Maybe Bool
Indicates whether utterances entered by the user should be sent to Amazon Comprehend for sentiment analysis.
locale :: Maybe Locale
Specifies the target locale for the bot.
createdDate :: Maybe POSIX
The date when the bot version was created.
name :: Maybe Text
The name of the bot.
version :: Maybe Text
The version of the bot.
idleSessionTTLInSeconds :: Maybe Natural
The maximum time in seconds that Amazon Lex retains the data gathered in a conversation. For more information, see PutBot.
clarificationPrompt :: Maybe Prompt
The message that Amazon Lex uses when it doesn't understand the user's request. For more information, see PutBot.
voiceId :: Maybe Text
The Amazon Polly voice ID that Amazon Lex uses for voice interactions with the user.
lastUpdatedDate :: Maybe POSIX
The date when the $LATEST version of this bot was updated.
childDirected :: Maybe Bool
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.
description :: Maybe Text
A description of the bot.
httpStatus :: Int
The response's http status code.

Instances

Instances details

Eq CreateBotVersionResponse Source #
Instance details Defined in Amazonka.LexModels.CreateBotVersion Methods (==) :: CreateBotVersionResponse -> CreateBotVersionResponse -> Bool # (/=) :: CreateBotVersionResponse -> CreateBotVersionResponse -> Bool #
Read CreateBotVersionResponse Source #
Instance details Defined in Amazonka.LexModels.CreateBotVersion Methods readsPrec :: Int -> ReadS CreateBotVersionResponse # readList :: ReadS [CreateBotVersionResponse] # readPrec :: ReadPrec CreateBotVersionResponse # readListPrec :: ReadPrec [CreateBotVersionResponse] #
Show CreateBotVersionResponse Source #
Instance details Defined in Amazonka.LexModels.CreateBotVersion Methods showsPrec :: Int -> CreateBotVersionResponse -> ShowS # show :: CreateBotVersionResponse -> String # showList :: [CreateBotVersionResponse] -> ShowS #
Generic CreateBotVersionResponse Source #
Instance details Defined in Amazonka.LexModels.CreateBotVersion Associated Types type Rep CreateBotVersionResponse :: Type -> Type # Methods from :: CreateBotVersionResponse -> Rep CreateBotVersionResponse x # to :: Rep CreateBotVersionResponse x -> CreateBotVersionResponse #
NFData CreateBotVersionResponse Source #
Instance details Defined in Amazonka.LexModels.CreateBotVersion Methods rnf :: CreateBotVersionResponse -> () #
type Rep CreateBotVersionResponse Source #
Instance details Defined in Amazonka.LexModels.CreateBotVersion type Rep CreateBotVersionResponse = D1 ('MetaData "CreateBotVersionResponse" "Amazonka.LexModels.CreateBotVersion" "libZSservicesZSamazonka-lex-modelsZSamazonka-lex-models" 'False) (C1 ('MetaCons "CreateBotVersionResponse'" 'PrefixI 'True) ((((S1 ('MetaSel ('Just "failureReason") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :: S1 ('MetaSel ('Just "status") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe LexStatus))) :: (S1 ('MetaSel ('Just "abortStatement") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Statement)) :: S1 ('MetaSel ('Just "intents") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe [Intent])))) :: ((S1 ('MetaSel ('Just "checksum") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :: S1 ('MetaSel ('Just "enableModelImprovements") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Bool))) :: (S1 ('MetaSel ('Just "detectSentiment") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Bool)) :: (S1 ('MetaSel ('Just "locale") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Locale)) :: S1 ('MetaSel ('Just "createdDate") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe POSIX)))))) :: (((S1 ('MetaSel ('Just "name") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :: S1 ('MetaSel ('Just "version") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text))) :: (S1 ('MetaSel ('Just "idleSessionTTLInSeconds") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Natural)) :: S1 ('MetaSel ('Just "clarificationPrompt") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Prompt)))) :: ((S1 ('MetaSel ('Just "voiceId") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :: S1 ('MetaSel ('Just "lastUpdatedDate") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe POSIX))) :: (S1 ('MetaSel ('Just "childDirected") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Bool)) :: (S1 ('MetaSel ('Just "description") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :*: S1 ('MetaSel ('Just "httpStatus") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Int)))))))

newCreateBotVersionResponse Source #

Arguments

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

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:failureReason:CreateBotVersionResponse', createBotVersionResponse_failureReason - If status is FAILED, Amazon Lex provides the reason that it failed to build the bot.

$sel:status: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.

$sel:abortStatement:CreateBotVersionResponse', createBotVersionResponse_abortStatement - The message that Amazon Lex uses to cancel a conversation. For more information, see PutBot.

$sel:intents:CreateBotVersionResponse', createBotVersionResponse_intents - An array of Intent objects. For more information, see PutBot.

$sel:checksum:CreateBotVersion', createBotVersionResponse_checksum - Checksum identifying the version of the bot that was created.

$sel:enableModelImprovements:CreateBotVersionResponse', createBotVersionResponse_enableModelImprovements - Indicates whether the bot uses accuracy improvements. true indicates that the bot is using the improvements, otherwise, false.

$sel:detectSentiment:CreateBotVersionResponse', createBotVersionResponse_detectSentiment - Indicates whether utterances entered by the user should be sent to Amazon Comprehend for sentiment analysis.

$sel:locale:CreateBotVersionResponse', createBotVersionResponse_locale - Specifies the target locale for the bot.

$sel:createdDate:CreateBotVersionResponse', createBotVersionResponse_createdDate - The date when the bot version was created.

$sel:name:CreateBotVersion', createBotVersionResponse_name - The name of the bot.

$sel:version:CreateBotVersionResponse', createBotVersionResponse_version - The version of 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:clarificationPrompt:CreateBotVersionResponse', createBotVersionResponse_clarificationPrompt - The message that Amazon Lex uses when it doesn't understand the user's request. For more information, see PutBot.

$sel:voiceId:CreateBotVersionResponse', createBotVersionResponse_voiceId - The Amazon Polly voice ID that Amazon Lex uses for voice interactions with the user.

$sel:lastUpdatedDate:CreateBotVersionResponse', createBotVersionResponse_lastUpdatedDate - The date when the $LATEST version of this bot was updated.

$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:description:CreateBotVersionResponse', createBotVersionResponse_description - A description of the bot.

$sel:httpStatus:CreateBotVersionResponse', createBotVersionResponse_httpStatus - The response's http status code.

Response Lenses

createBotVersionResponse_failureReason :: Lens' CreateBotVersionResponse (Maybe Text) Source #

If status is FAILED, Amazon Lex provides the reason that it failed to build 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_abortStatement :: Lens' CreateBotVersionResponse (Maybe Statement) Source #

The message that Amazon Lex uses to cancel 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_checksum :: Lens' CreateBotVersionResponse (Maybe Text) Source #

Checksum identifying the version of the bot that was created.

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_detectSentiment :: Lens' CreateBotVersionResponse (Maybe Bool) Source #

Indicates whether utterances entered by the user should be sent to Amazon Comprehend for sentiment analysis.

createBotVersionResponse_locale :: Lens' CreateBotVersionResponse (Maybe Locale) Source #

Specifies the target locale for the bot.

createBotVersionResponse_createdDate :: Lens' CreateBotVersionResponse (Maybe UTCTime) Source #

The date when the bot version was created.

createBotVersionResponse_name :: Lens' CreateBotVersionResponse (Maybe Text) Source #

The name of the bot.

createBotVersionResponse_version :: Lens' CreateBotVersionResponse (Maybe Text) Source #

The version of 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_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_voiceId :: Lens' CreateBotVersionResponse (Maybe Text) Source #

The Amazon Polly voice ID that Amazon Lex uses for voice interactions with the user.

createBotVersionResponse_lastUpdatedDate :: Lens' CreateBotVersionResponse (Maybe UTCTime) Source #

The date when the $LATEST version of this bot was updated.

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

A description of the bot.

createBotVersionResponse_httpStatus :: Lens' CreateBotVersionResponse Int Source #

The response's http status code.