amazonka-lex-models-1.5.0: Amazon Lex Model Building Service SDK.

Copyright(c) 2013-2017 Brendan Hay
LicenseMozilla Public License, v. 2.0.
MaintainerBrendan Hay <brendan.g.hay+amazonka@gmail.com>
Stabilityauto-generated
Portabilitynon-portable (GHC extensions)
Safe HaskellNone
LanguageHaskell2010

Network.AWS.LexModels.CreateBotVersion

Contents

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.

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

createBotVersion Source #

Creates a value of CreateBotVersion with the minimum fields required to make a request.

Use one of the following lenses to modify other fields as desired:

  • cbvChecksum - 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.
  • cbvName - The name of the bot that you want to create a new version of. The name is case sensitive.

data CreateBotVersion Source #

See: createBotVersion smart constructor.

Instances

Eq CreateBotVersion Source # 
Data CreateBotVersion Source # 

Methods

gfoldl :: (forall d b. Data d => c (d -> b) -> d -> c b) -> (forall g. g -> c g) -> CreateBotVersion -> c CreateBotVersion #

gunfold :: (forall b r. Data b => c (b -> r) -> c r) -> (forall r. r -> c r) -> Constr -> c CreateBotVersion #

toConstr :: CreateBotVersion -> Constr #

dataTypeOf :: CreateBotVersion -> DataType #

dataCast1 :: Typeable (* -> *) t => (forall d. Data d => c (t d)) -> Maybe (c CreateBotVersion) #

dataCast2 :: Typeable (* -> * -> *) t => (forall d e. (Data d, Data e) => c (t d e)) -> Maybe (c CreateBotVersion) #

gmapT :: (forall b. Data b => b -> b) -> CreateBotVersion -> CreateBotVersion #

gmapQl :: (r -> r' -> r) -> r -> (forall d. Data d => d -> r') -> CreateBotVersion -> r #

gmapQr :: (r' -> r -> r) -> r -> (forall d. Data d => d -> r') -> CreateBotVersion -> r #

gmapQ :: (forall d. Data d => d -> u) -> CreateBotVersion -> [u] #

gmapQi :: Int -> (forall d. Data d => d -> u) -> CreateBotVersion -> u #

gmapM :: Monad m => (forall d. Data d => d -> m d) -> CreateBotVersion -> m CreateBotVersion #

gmapMp :: MonadPlus m => (forall d. Data d => d -> m d) -> CreateBotVersion -> m CreateBotVersion #

gmapMo :: MonadPlus m => (forall d. Data d => d -> m d) -> CreateBotVersion -> m CreateBotVersion #

Read CreateBotVersion Source # 
Show CreateBotVersion Source # 
Generic CreateBotVersion Source # 
Hashable CreateBotVersion Source # 
ToJSON CreateBotVersion Source # 
NFData CreateBotVersion Source # 

Methods

rnf :: CreateBotVersion -> () #

AWSRequest CreateBotVersion Source # 
ToQuery CreateBotVersion Source # 
ToPath CreateBotVersion Source # 
ToHeaders CreateBotVersion Source # 
type Rep CreateBotVersion Source # 
type Rep CreateBotVersion = D1 (MetaData "CreateBotVersion" "Network.AWS.LexModels.CreateBotVersion" "amazonka-lex-models-1.5.0-9L7od5njsTvH7y9BfUkUqe" False) (C1 (MetaCons "CreateBotVersion'" PrefixI True) ((:*:) (S1 (MetaSel (Just Symbol "_cbvChecksum") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 (Maybe Text))) (S1 (MetaSel (Just Symbol "_cbvName") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 Text))))
type Rs CreateBotVersion Source # 

Request Lenses

cbvChecksum :: 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.

cbvName :: 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

createBotVersionResponse Source #

Creates a value of CreateBotVersionResponse with the minimum fields required to make a request.

Use one of the following lenses to modify other fields as desired:

  • cbvrsFailureReason - If status is FAILED , Amazon Lex provides the reason that it failed to build the bot.
  • cbvrsStatus - 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.
  • cbvrsAbortStatement - The message that Amazon Lex uses to abort a conversation. For more information, see PutBot .
  • cbvrsIntents - An array of Intent objects. For more information, see PutBot .
  • cbvrsChecksum - Checksum identifying the version of the bot that was created.
  • cbvrsLocale - Specifies the target locale for the bot.
  • cbvrsCreatedDate - The date when the bot version was created.
  • cbvrsName - The name of the bot.
  • cbvrsVersion - The version of the bot.
  • cbvrsIdleSessionTTLInSeconds - The maximum time in seconds that Amazon Lex retains the data gathered in a conversation. For more information, see PutBot .
  • cbvrsClarificationPrompt - The message that Amazon Lex uses when it doesn't understand the user's request. For more information, see PutBot .
  • cbvrsVoiceId - The Amazon Polly voice ID that Amazon Lex uses for voice interactions with the user.
  • cbvrsLastUpdatedDate - The date when the > LATEST version of this bot was updated.
  • cbvrsChildDirected - 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.
  • cbvrsDescription - A description of the bot.
  • cbvrsResponseStatus - -- | The response status code.

data CreateBotVersionResponse Source #

See: createBotVersionResponse smart constructor.

Instances

Eq CreateBotVersionResponse Source # 
Data CreateBotVersionResponse Source # 

Methods

gfoldl :: (forall d b. Data d => c (d -> b) -> d -> c b) -> (forall g. g -> c g) -> CreateBotVersionResponse -> c CreateBotVersionResponse #

gunfold :: (forall b r. Data b => c (b -> r) -> c r) -> (forall r. r -> c r) -> Constr -> c CreateBotVersionResponse #

toConstr :: CreateBotVersionResponse -> Constr #

dataTypeOf :: CreateBotVersionResponse -> DataType #

dataCast1 :: Typeable (* -> *) t => (forall d. Data d => c (t d)) -> Maybe (c CreateBotVersionResponse) #

dataCast2 :: Typeable (* -> * -> *) t => (forall d e. (Data d, Data e) => c (t d e)) -> Maybe (c CreateBotVersionResponse) #

gmapT :: (forall b. Data b => b -> b) -> CreateBotVersionResponse -> CreateBotVersionResponse #

gmapQl :: (r -> r' -> r) -> r -> (forall d. Data d => d -> r') -> CreateBotVersionResponse -> r #

gmapQr :: (r' -> r -> r) -> r -> (forall d. Data d => d -> r') -> CreateBotVersionResponse -> r #

gmapQ :: (forall d. Data d => d -> u) -> CreateBotVersionResponse -> [u] #

gmapQi :: Int -> (forall d. Data d => d -> u) -> CreateBotVersionResponse -> u #

gmapM :: Monad m => (forall d. Data d => d -> m d) -> CreateBotVersionResponse -> m CreateBotVersionResponse #

gmapMp :: MonadPlus m => (forall d. Data d => d -> m d) -> CreateBotVersionResponse -> m CreateBotVersionResponse #

gmapMo :: MonadPlus m => (forall d. Data d => d -> m d) -> CreateBotVersionResponse -> m CreateBotVersionResponse #

Read CreateBotVersionResponse Source # 
Show CreateBotVersionResponse Source # 
Generic CreateBotVersionResponse Source # 
NFData CreateBotVersionResponse Source # 
type Rep CreateBotVersionResponse Source # 
type Rep CreateBotVersionResponse = D1 (MetaData "CreateBotVersionResponse" "Network.AWS.LexModels.CreateBotVersion" "amazonka-lex-models-1.5.0-9L7od5njsTvH7y9BfUkUqe" False) (C1 (MetaCons "CreateBotVersionResponse'" PrefixI True) ((:*:) ((:*:) ((:*:) ((:*:) (S1 (MetaSel (Just Symbol "_cbvrsFailureReason") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 (Maybe Text))) (S1 (MetaSel (Just Symbol "_cbvrsStatus") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 (Maybe LexStatus)))) ((:*:) (S1 (MetaSel (Just Symbol "_cbvrsAbortStatement") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 (Maybe Statement))) (S1 (MetaSel (Just Symbol "_cbvrsIntents") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 (Maybe [Intent]))))) ((:*:) ((:*:) (S1 (MetaSel (Just Symbol "_cbvrsChecksum") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 (Maybe Text))) (S1 (MetaSel (Just Symbol "_cbvrsLocale") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 (Maybe Locale)))) ((:*:) (S1 (MetaSel (Just Symbol "_cbvrsCreatedDate") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 (Maybe POSIX))) (S1 (MetaSel (Just Symbol "_cbvrsName") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 (Maybe Text)))))) ((:*:) ((:*:) ((:*:) (S1 (MetaSel (Just Symbol "_cbvrsVersion") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 (Maybe Text))) (S1 (MetaSel (Just Symbol "_cbvrsIdleSessionTTLInSeconds") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 (Maybe Nat)))) ((:*:) (S1 (MetaSel (Just Symbol "_cbvrsClarificationPrompt") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 (Maybe Prompt))) (S1 (MetaSel (Just Symbol "_cbvrsVoiceId") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 (Maybe Text))))) ((:*:) ((:*:) (S1 (MetaSel (Just Symbol "_cbvrsLastUpdatedDate") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 (Maybe POSIX))) (S1 (MetaSel (Just Symbol "_cbvrsChildDirected") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 (Maybe Bool)))) ((:*:) (S1 (MetaSel (Just Symbol "_cbvrsDescription") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 (Maybe Text))) (S1 (MetaSel (Just Symbol "_cbvrsResponseStatus") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 Int)))))))

Response Lenses

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

If status is FAILED , Amazon Lex provides the reason that it failed to build the bot.

cbvrsStatus :: 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.

cbvrsAbortStatement :: Lens' CreateBotVersionResponse (Maybe Statement) Source #

The message that Amazon Lex uses to abort a conversation. For more information, see PutBot .

cbvrsIntents :: Lens' CreateBotVersionResponse [Intent] Source #

An array of Intent objects. For more information, see PutBot .

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

Checksum identifying the version of the bot that was created.

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

Specifies the target locale for the bot.

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

The date when the bot version was created.

cbvrsIdleSessionTTLInSeconds :: 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 .

cbvrsClarificationPrompt :: 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 .

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

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

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

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

cbvrsChildDirected :: 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.