Copyright | (c) 2013-2018 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 |
Language | Haskell2010 |
Creates an Amazon Lex conversational bot or replaces an existing bot. When you create or update a bot you are only required to specify a name, a locale, and whether the bot is directed toward children under age 13. You can use this to add intents later, or to remove intents from an existing bot. When you create a bot with the minimum information, the bot is created or updated but Amazon Lex returns the response FAILED
. You can build the bot after you add one or more intents. For more information about Amazon Lex bots, see 'how-it-works' .
If you specify the name of an existing bot, the fields in the request replace the existing values in the > LATEST
version of the bot. Amazon Lex removes any fields that you don't provide values for in the request, except for the idleTTLInSeconds
and privacySettings
fields, which are set to their default values. If you don't specify values for required fields, Amazon Lex throws an exception.
This operation requires permissions for the lex:PutBot
action. For more information, see 'auth-and-access-control' .
- putBot :: Text -> Locale -> Bool -> PutBot
- data PutBot
- pbAbortStatement :: Lens' PutBot (Maybe Statement)
- pbIntents :: Lens' PutBot [Intent]
- pbChecksum :: Lens' PutBot (Maybe Text)
- pbProcessBehavior :: Lens' PutBot (Maybe ProcessBehavior)
- pbIdleSessionTTLInSeconds :: Lens' PutBot (Maybe Natural)
- pbClarificationPrompt :: Lens' PutBot (Maybe Prompt)
- pbVoiceId :: Lens' PutBot (Maybe Text)
- pbCreateVersion :: Lens' PutBot (Maybe Bool)
- pbDescription :: Lens' PutBot (Maybe Text)
- pbName :: Lens' PutBot Text
- pbLocale :: Lens' PutBot Locale
- pbChildDirected :: Lens' PutBot Bool
- putBotResponse :: Int -> PutBotResponse
- data PutBotResponse
- pbrsFailureReason :: Lens' PutBotResponse (Maybe Text)
- pbrsStatus :: Lens' PutBotResponse (Maybe LexStatus)
- pbrsAbortStatement :: Lens' PutBotResponse (Maybe Statement)
- pbrsIntents :: Lens' PutBotResponse [Intent]
- pbrsChecksum :: Lens' PutBotResponse (Maybe Text)
- pbrsLocale :: Lens' PutBotResponse (Maybe Locale)
- pbrsCreatedDate :: Lens' PutBotResponse (Maybe UTCTime)
- pbrsName :: Lens' PutBotResponse (Maybe Text)
- pbrsVersion :: Lens' PutBotResponse (Maybe Text)
- pbrsIdleSessionTTLInSeconds :: Lens' PutBotResponse (Maybe Natural)
- pbrsClarificationPrompt :: Lens' PutBotResponse (Maybe Prompt)
- pbrsVoiceId :: Lens' PutBotResponse (Maybe Text)
- pbrsLastUpdatedDate :: Lens' PutBotResponse (Maybe UTCTime)
- pbrsCreateVersion :: Lens' PutBotResponse (Maybe Bool)
- pbrsChildDirected :: Lens' PutBotResponse (Maybe Bool)
- pbrsDescription :: Lens' PutBotResponse (Maybe Text)
- pbrsResponseStatus :: Lens' PutBotResponse Int
Creating a Request
Creates a value of PutBot
with the minimum fields required to make a request.
Use one of the following lenses to modify other fields as desired:
pbAbortStatement
- When Amazon Lex can't understand the user's input in context, it tries to elicit the information a few times. After that, Amazon Lex sends the message defined inabortStatement
to the user, and then aborts the conversation. To set the number of retries, use thevalueElicitationPrompt
field for the slot type. For example, in a pizza ordering bot, Amazon Lex might ask a user "What type of crust would you like?" If the user's response is not one of the expected responses (for example, "thin crust, "deep dish," etc.), Amazon Lex tries to elicit a correct response a few more times. For example, in a pizza ordering application,OrderPizza
might be one of the intents. This intent might require theCrustType
slot. You specify thevalueElicitationPrompt
field when you create theCrustType
slot.pbIntents
- An array ofIntent
objects. Each intent represents a command that a user can express. For example, a pizza ordering bot might support an OrderPizza intent. For more information, see 'how-it-works' .pbChecksum
- Identifies a specific revision of the> LATEST
version. When you create a new bot, leave thechecksum
field blank. If you specify a checksum you get aBadRequestException
exception. When you want to update a bot, set thechecksum
field to the checksum of the most recent revision of the> LATEST
version. If you don't specify thechecksum
field, or if the checksum does not match the> LATEST
version, you get aPreconditionFailedException
exception.pbProcessBehavior
- If you set theprocessBehavior
element toBUILD
, Amazon Lex builds the bot so that it can be run. If you set the element toSAVE
Amazon Lex saves the bot, but doesn't build it. If you don't specify this value, the default value isBUILD
.pbIdleSessionTTLInSeconds
- The maximum time in seconds that Amazon Lex retains the data gathered in a conversation. A user interaction session remains active for the amount of time specified. If no conversation occurs during this time, the session expires and Amazon Lex deletes any data provided before the timeout. For example, suppose that a user chooses the OrderPizza intent, but gets sidetracked halfway through placing an order. If the user doesn't complete the order within the specified time, Amazon Lex discards the slot information that it gathered, and the user must start over. If you don't include theidleSessionTTLInSeconds
element in aPutBot
operation request, Amazon Lex uses the default value. This is also true if the request replaces an existing bot. The default is 300 seconds (5 minutes).pbClarificationPrompt
- When Amazon Lex doesn't understand the user's intent, it uses this message to get clarification. To specify how many times Amazon Lex should repeate the clarification prompt, use themaxAttempts
field. If Amazon Lex still doesn't understand, it sends the message in theabortStatement
field. When you create a clarification prompt, make sure that it suggests the correct response from the user. for example, for a bot that orders pizza and drinks, you might create this clarification prompt: "What would you like to do? You can say 'Order a pizza' or 'Order a drink.'"pbVoiceId
- The Amazon Polly voice ID that you want Amazon Lex to use for voice interactions with the user. The locale configured for the voice must match the locale of the bot. For more information, see Available Voices in the Amazon Polly Developer Guide .pbCreateVersion
- Undocumented member.pbDescription
- A description of the bot.pbName
- The name of the bot. The name is not case sensitive.pbLocale
- Specifies the target locale for the bot. Any intent used in the bot must be compatible with the locale of the bot. The default isen-US
.pbChildDirected
- 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 specifyingtrue
orfalse
in thechildDirected
field. By specifyingtrue
in thechildDirected
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 specifyingfalse
in thechildDirected
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 thechildDirected
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.
See: putBot
smart constructor.
Eq PutBot Source # | |
Data PutBot Source # | |
Read PutBot Source # | |
Show PutBot Source # | |
Generic PutBot Source # | |
Hashable PutBot Source # | |
ToJSON PutBot Source # | |
NFData PutBot Source # | |
AWSRequest PutBot Source # | |
ToHeaders PutBot Source # | |
ToPath PutBot Source # | |
ToQuery PutBot Source # | |
type Rep PutBot Source # | |
type Rs PutBot Source # | |
Request Lenses
pbAbortStatement :: Lens' PutBot (Maybe Statement) Source #
When Amazon Lex can't understand the user's input in context, it tries to elicit the information a few times. After that, Amazon Lex sends the message defined in abortStatement
to the user, and then aborts the conversation. To set the number of retries, use the valueElicitationPrompt
field for the slot type. For example, in a pizza ordering bot, Amazon Lex might ask a user "What type of crust would you like?" If the user's response is not one of the expected responses (for example, "thin crust, "deep dish," etc.), Amazon Lex tries to elicit a correct response a few more times. For example, in a pizza ordering application, OrderPizza
might be one of the intents. This intent might require the CrustType
slot. You specify the valueElicitationPrompt
field when you create the CrustType
slot.
pbIntents :: Lens' PutBot [Intent] Source #
An array of Intent
objects. Each intent represents a command that a user can express. For example, a pizza ordering bot might support an OrderPizza intent. For more information, see 'how-it-works' .
pbChecksum :: Lens' PutBot (Maybe Text) Source #
Identifies a specific revision of the > LATEST
version. When you create a new bot, leave the checksum
field blank. If you specify a checksum you get a BadRequestException
exception. When you want to update a bot, set the checksum
field to the checksum of the most recent revision of the > LATEST
version. If you don't specify the checksum
field, or if the checksum does not match the > LATEST
version, you get a PreconditionFailedException
exception.
pbProcessBehavior :: Lens' PutBot (Maybe ProcessBehavior) Source #
If you set the processBehavior
element to BUILD
, Amazon Lex builds the bot so that it can be run. If you set the element to SAVE
Amazon Lex saves the bot, but doesn't build it. If you don't specify this value, the default value is BUILD
.
pbIdleSessionTTLInSeconds :: Lens' PutBot (Maybe Natural) Source #
The maximum time in seconds that Amazon Lex retains the data gathered in a conversation. A user interaction session remains active for the amount of time specified. If no conversation occurs during this time, the session expires and Amazon Lex deletes any data provided before the timeout. For example, suppose that a user chooses the OrderPizza intent, but gets sidetracked halfway through placing an order. If the user doesn't complete the order within the specified time, Amazon Lex discards the slot information that it gathered, and the user must start over. If you don't include the idleSessionTTLInSeconds
element in a PutBot
operation request, Amazon Lex uses the default value. This is also true if the request replaces an existing bot. The default is 300 seconds (5 minutes).
pbClarificationPrompt :: Lens' PutBot (Maybe Prompt) Source #
When Amazon Lex doesn't understand the user's intent, it uses this message to get clarification. To specify how many times Amazon Lex should repeate the clarification prompt, use the maxAttempts
field. If Amazon Lex still doesn't understand, it sends the message in the abortStatement
field. When you create a clarification prompt, make sure that it suggests the correct response from the user. for example, for a bot that orders pizza and drinks, you might create this clarification prompt: "What would you like to do? You can say 'Order a pizza' or 'Order a drink.'"
pbVoiceId :: Lens' PutBot (Maybe Text) Source #
The Amazon Polly voice ID that you want Amazon Lex to use for voice interactions with the user. The locale configured for the voice must match the locale of the bot. For more information, see Available Voices in the Amazon Polly Developer Guide .
pbLocale :: Lens' PutBot Locale Source #
Specifies the target locale for the bot. Any intent used in the bot must be compatible with the locale of the bot. The default is en-US
.
pbChildDirected :: Lens' PutBot 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.
Destructuring the Response
Creates a value of PutBotResponse
with the minimum fields required to make a request.
Use one of the following lenses to modify other fields as desired:
pbrsFailureReason
- Ifstatus
isFAILED
, Amazon Lex provides the reason that it failed to build the bot.pbrsStatus
- When you send a request to create a bot withprocessBehavior
set toBUILD
, Amazon Lex sets thestatus
response element toBUILDING
. After Amazon Lex builds the bot, it setsstatus
toREADY
. If Amazon Lex can't build the bot, Amazon Lex setsstatus
toFAILED
. Amazon Lex returns the reason for the failure in thefailureReason
response element. When you setprocessBehavior
toSAVE
, Amazon Lex sets the status code toNOT BUILT
.pbrsAbortStatement
- The message that Amazon Lex uses to abort a conversation. For more information, seePutBot
.pbrsIntents
- An array ofIntent
objects. For more information, seePutBot
.pbrsChecksum
- Checksum of the bot that you created.pbrsLocale
- The target locale for the bot.pbrsCreatedDate
- The date that the bot was created.pbrsName
- The name of the bot.pbrsVersion
- The version of the bot. For a new bot, the version is always> LATEST
.pbrsIdleSessionTTLInSeconds
- The maximum length of time that Amazon Lex retains the data gathered in a conversation. For more information, seePutBot
.pbrsClarificationPrompt
- The prompts that Amazon Lex uses when it doesn't understand the user's intent. For more information, seePutBot
.pbrsVoiceId
- The Amazon Polly voice ID that Amazon Lex uses for voice interaction with the user. For more information, seePutBot
.pbrsLastUpdatedDate
- The date that the bot was updated. When you create a resource, the creation date and last updated date are the same.pbrsCreateVersion
- Undocumented member.pbrsChildDirected
- 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 specifyingtrue
orfalse
in thechildDirected
field. By specifyingtrue
in thechildDirected
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 specifyingfalse
in thechildDirected
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 thechildDirected
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.pbrsDescription
- A description of the bot.pbrsResponseStatus
- -- | The response status code.
data PutBotResponse Source #
See: putBotResponse
smart constructor.
Response Lenses
pbrsFailureReason :: Lens' PutBotResponse (Maybe Text) Source #
If status
is FAILED
, Amazon Lex provides the reason that it failed to build the bot.
pbrsStatus :: Lens' PutBotResponse (Maybe LexStatus) Source #
When you send a request to create a bot with processBehavior
set to BUILD
, 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, Amazon Lex sets status
to FAILED
. Amazon Lex returns the reason for the failure in the failureReason
response element. When you set processBehavior
to SAVE
, Amazon Lex sets the status code to NOT BUILT
.
pbrsAbortStatement :: Lens' PutBotResponse (Maybe Statement) Source #
The message that Amazon Lex uses to abort a conversation. For more information, see PutBot
.
pbrsIntents :: Lens' PutBotResponse [Intent] Source #
An array of Intent
objects. For more information, see PutBot
.
pbrsChecksum :: Lens' PutBotResponse (Maybe Text) Source #
Checksum of the bot that you created.
pbrsLocale :: Lens' PutBotResponse (Maybe Locale) Source #
The target locale for the bot.
pbrsCreatedDate :: Lens' PutBotResponse (Maybe UTCTime) Source #
The date that the bot was created.
pbrsVersion :: Lens' PutBotResponse (Maybe Text) Source #
The version of the bot. For a new bot, the version is always > LATEST
.
pbrsIdleSessionTTLInSeconds :: Lens' PutBotResponse (Maybe Natural) Source #
The maximum length of time that Amazon Lex retains the data gathered in a conversation. For more information, see PutBot
.
pbrsClarificationPrompt :: Lens' PutBotResponse (Maybe Prompt) Source #
The prompts that Amazon Lex uses when it doesn't understand the user's intent. For more information, see PutBot
.
pbrsVoiceId :: Lens' PutBotResponse (Maybe Text) Source #
The Amazon Polly voice ID that Amazon Lex uses for voice interaction with the user. For more information, see PutBot
.
pbrsLastUpdatedDate :: Lens' PutBotResponse (Maybe UTCTime) Source #
The date that the bot was updated. When you create a resource, the creation date and last updated date are the same.
pbrsCreateVersion :: Lens' PutBotResponse (Maybe Bool) Source #
Undocumented member.
pbrsChildDirected :: Lens' PutBotResponse (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.
pbrsDescription :: Lens' PutBotResponse (Maybe Text) Source #
A description of the bot.
pbrsResponseStatus :: Lens' PutBotResponse Int Source #
- - | The response status code.