AWS services or capabilities described in AWS Documentation may vary by region/location. Click Getting Started with Amazon AWS to see specific differences applicable to the China (Beijing) Region.
Write-LMBBot-Name <String>-AbortStatement <Statement>-Checksum <String>-ChildDirected <Boolean>-CreateVersion <Boolean>-Description <String>-DetectSentiment <Boolean>-EnableModelImprovement <Boolean>-IdleSessionTTLInSecond <Int32>-Intent <Intent[]>-Locale <Locale>-ClarificationPrompt_MaxAttempt <Int32>-ClarificationPrompt_Message <Message[]>-NluIntentConfidenceThreshold <Double>-ProcessBehavior <ProcessBehavior>-ClarificationPrompt_ResponseCard <String>-Tag <Tag[]>-VoiceId <String>-Select <String>-PassThru <SwitchParameter>-Force <SwitchParameter>
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 security-iam. abortStatement
to the user, and then cancels 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.If you have defined a fallback intent the cancel statement will not be sent to the user, the fallback intent is used instead. For more information, see AMAZON.FallbackIntent. Required? | False |
Position? | Named |
Accept pipeline input? | True (ByPropertyName) |
$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. Required? | False |
Position? | Named |
Accept pipeline input? | True (ByPropertyName) |
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. Required? | True |
Position? | Named |
Accept pipeline input? | True (ByPropertyName) |
Required? | False |
Position? | Named |
Accept pipeline input? | True (ByPropertyName) |
Aliases | ClarificationPrompt_MaxAttempts |
Required? | False |
Position? | Named |
Accept pipeline input? | True (ByPropertyName) |
Aliases | ClarificationPrompt_Messages |
PostText
API response. It substitutes session attributes and slot values for placeholders in the response card. For more information, see ex-resp-card. Required? | False |
Position? | Named |
Accept pipeline input? | True (ByPropertyName) |
true
a new numbered version of the bot is created. This is the same as calling the CreateBotVersion
operation. If you don't specify createVersion
, the default is false
. Required? | False |
Position? | Named |
Accept pipeline input? | True (ByPropertyName) |
Required? | False |
Position? | Named |
Accept pipeline input? | True (ByPropertyName) |
true
user utterances are sent to Amazon Comprehend for sentiment analysis. If you don't specify detectSentiment
, the default is false
. Required? | False |
Position? | Named |
Accept pipeline input? | True (ByPropertyName) |
true
to enable access to natural language understanding improvements.When you set the enableModelImprovements
parameter to true
you can use the nluIntentConfidenceThreshold
parameter to configure confidence scores. For more information, see Confidence Scores.You can only set the enableModelImprovements
parameter in certain Regions. If you set the parameter to true
, your bot has access to accuracy improvements.The Regions where you can set the enableModelImprovements
parameter to true
are:enableModelImprovements
parameter is set to true
by default. In these Regions setting the parameter to false
throws a ValidationException
exception. Required? | False |
Position? | Named |
Accept pipeline input? | True (ByPropertyName) |
Aliases | EnableModelImprovements |
Required? | False |
Position? | Named |
Accept pipeline input? | True (ByPropertyName) |
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). Required? | False |
Position? | Named |
Accept pipeline input? | True (ByPropertyName) |
Aliases | IdleSessionTTLInSeconds |
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. Required? | False |
Position? | Named |
Accept pipeline input? | True (ByPropertyName) |
Aliases | Intents |
en-US
. Required? | True |
Position? | Named |
Accept pipeline input? | True (ByPropertyName) |
Required? | True |
Position? | 1 |
Accept pipeline input? | True (ByValue, ByPropertyName) |
AMAZON.FallbackIntent
, AMAZON.KendraSearchIntent
, or both when returning alternative intents in a PostContent or PostText response. AMAZON.FallbackIntent
and AMAZON.KendraSearchIntent
are only inserted if they are configured for the bot.You must set the enableModelImprovements
parameter to true
to use confidence scores in the following regions.enableModelImprovements
parameter is set to true
by default.For example, suppose a bot is configured with the confidence threshold of 0.80 and the AMAZON.FallbackIntent
. Amazon Lex returns three alternative intents with the following confidence scores: IntentA (0.70), IntentB (0.60), IntentC (0.50). The response from the PostText
operation would be:Required? | False |
Position? | Named |
Accept pipeline input? | True (ByPropertyName) |
Required? | False |
Position? | Named |
Accept pipeline input? | True (ByPropertyName) |
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
. Required? | False |
Position? | Named |
Accept pipeline input? | True (ByPropertyName) |
Required? | False |
Position? | Named |
Accept pipeline input? | True (ByPropertyName) |
PutBot
operation to update the tags on a bot. To update tags, use the TagResource
operation. Required? | False |
Position? | Named |
Accept pipeline input? | True (ByPropertyName) |
Aliases | Tags |
Required? | False |
Position? | Named |
Accept pipeline input? | True (ByPropertyName) |
Required? | False |
Position? | Named |
Accept pipeline input? | True (ByPropertyName) |
Aliases | AK |
Required? | False |
Position? | Named |
Accept pipeline input? | True (ByValue, ByPropertyName) |
Required? | False |
Position? | Named |
Accept pipeline input? | True (ByPropertyName) |
Required? | False |
Position? | Named |
Accept pipeline input? | True (ByValue, ByPropertyName) |
Required? | False |
Position? | Named |
Accept pipeline input? | True (ByPropertyName) |
Aliases | AWSProfilesLocation, ProfilesLocation |
Required? | False |
Position? | Named |
Accept pipeline input? | True (ByPropertyName) |
Aliases | StoredCredentials, AWSProfileName |
Required? | False |
Position? | Named |
Accept pipeline input? | True (ByPropertyName) |
Aliases | RegionToCall |
Required? | False |
Position? | Named |
Accept pipeline input? | True (ByPropertyName) |
Aliases | SK, SecretAccessKey |
Required? | False |
Position? | Named |
Accept pipeline input? | True (ByPropertyName) |
Aliases | ST |
AWS Tools for PowerShell: 2.x.y.z