Amazon Lex Model Building Service: Write-LMBBot Cmdlet

Synopsis

Calls the Amazon Lex Model Building Service PutBot API operation.

Syntax

Write-LMBBot
-Name <String>
-AbortStatement <Statement>
-Checksum <String>
-ChildDirected <Boolean>
-CreateVersion <Boolean>
-Description <String>
-IdleSessionTTLInSecond <Int32>
-Intent <Intent[]>
-Locale <Locale>
-ClarificationPrompt_MaxAttempt <Int32>
-ClarificationPrompt_Message <Message[]>
-ProcessBehavior <ProcessBehavior>
-ClarificationPrompt_ResponseCard <String>
-VoiceId <String>
-Force <SwitchParameter>

Description

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.





Parameters



-AbortStatement <Statement>
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. 
Required? False
Position? Named
Accept pipeline input? False
-Checksum <String>
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. 
Required? False
Position? Named
Accept pipeline input? False
-ChildDirected <Boolean>
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. 
Required? False
Position? Named
Accept pipeline input? False
-ClarificationPrompt_MaxAttempt <Int32>
The number of times to prompt the user for information. 
Required? False
Position? Named
Accept pipeline input? False
Aliases ClarificationPrompt_MaxAttempts
-ClarificationPrompt_Message <Message[]>
An array of objects, each of which provides a message string and its type. You can specify the message string in plain text or in Speech Synthesis Markup Language (SSML). 
Required? False
Position? Named
Accept pipeline input? False
Aliases ClarificationPrompt_Messages
-ClarificationPrompt_ResponseCard <String>
A response card. Amazon Lex uses this prompt at runtime, in the 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? False
-CreateVersion <Boolean>
The service has not provided documentation for this parameter; please refer to the service's API reference documentation for the latest available information. 
Required? False
Position? Named
Accept pipeline input? False
-Description <String>
A description of the bot. 
Required? False
Position? Named
Accept pipeline input? False
-Force <SwitchParameter>
This parameter overrides confirmation prompts to force  the cmdlet to continue its operation. This parameter should always be used with caution. 
Required? False
Position? Named
Accept pipeline input? False
-IdleSessionTTLInSecond <Int32>
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). 
Required? False
Position? Named
Accept pipeline input? False
Aliases IdleSessionTTLInSeconds
-Intent <Intent[]>
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. 
Required? False
Position? Named
Accept pipeline input? False
Aliases Intents
-Locale <Locale>
 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. 
Required? False
Position? Named
Accept pipeline input? False
-Name <String>
The name of the bot. The name is not case sensitive.  
Required? False
Position? 1
Accept pipeline input? True (ByValue, )
-ProcessBehavior <ProcessBehavior>
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. 
Required? False
Position? Named
Accept pipeline input? False
-VoiceId <String>
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. 
Required? False
Position? Named
Accept pipeline input? False





Common Credential and Region Parameters






    -AccessKey <String>
    
        The AWS access key for the user account. This can be a temporary access key
        if the corresponding session token is supplied to the -SessionToken parameter.
    
    
        
            
                Required?
                False
            
            
                Position?
                Named
            
            
                Accept pipeline input?
                False
            
        
    


    -Credential <AWSCredentials>
    
        An AWSCredentials object instance containing access and secret key information,
        and optionally a token for session-based credentials.
    
    
        
            
                Required?
                False
            
            
                Position?
                Named
            
            
                Accept pipeline input?
                False
            
        
    


    -ProfileLocation <String>
    
        
            Used to specify the name and location of the ini-format credential file (shared with
            the AWS CLI and other AWS SDKs)
        
        
            If this optional parameter is omitted this cmdlet will search the encrypted credential
            file used by the AWS SDK for .NET and AWS Toolkit for Visual Studio first.
            If the profile is not found then the cmdlet will search in the ini-format credential
            file at the default location: (user's home directory)\.aws\credentials.
            Note that the encrypted credential file is not supported on all platforms.
            It will be skipped when searching for profiles on Windows Nano Server, Mac, and Linux platforms.
        
        
            If this parameter is specified then this cmdlet will only search the ini-format credential
            file at the location given.
        
        
            As the current folder can vary in a shell or during script execution it is advised
            that you use specify a fully qualified path instead of a relative path.
        
    
    
        
            
                Required?
                False
            
            
                Position?
                Named
            
            
                Accept pipeline input?
                False
            
        
    


    -ProfileName <String>
    
        The user-defined name of an AWS credentials or SAML-based role profile containing
        credential information. The profile is expected to be found in the secure credential
        file shared with the AWS SDK for .NET and AWS Toolkit for Visual Studio. You can also
        specify the name of a profile stored in the .ini-format credential file used with
        the AWS CLI and other AWS SDKs.
    
    
        
            
                Required?
                False
            
            
                Position?
                Named
            
            
                Accept pipeline input?
                False
            
        
    


    -NetworkCredential <PSCredential>
    
        Used with SAML-based authentication when ProfileName references a SAML role profile.
        Contains the network credentials to be supplied during authentication with the
        configured identity provider's endpoint. This parameter is not required if the
        user's default network identity can or should be used during authentication.
    
    
        
            
                Required?
                False
            
            
                Position?
                Named
            
            
                Accept pipeline input?
                False
            
        
    


    -SecretKey <String>
    
        The AWS secret key for the user account. This can be a temporary secret key
        if the corresponding session token is supplied to the -SessionToken parameter.
    
    
        
            
                Required?
                False
            
            
                Position?
                Named
            
            
                Accept pipeline input?
                False
            
        
    


    -SessionToken <String>
    
        The session token if the access and secret keys are temporary session-based
        credentials.
    
    
        
            
                Required?
                False
            
            
                Position?
                Named
            
            
                Accept pipeline input?
                False
            
        
    


    -Region <String>
    The system name of the AWS region in which the operation should be invoked. For example, us-east-1, eu-west-1 etc.
    
        
            
                Required?
                False
            
            
                Position?
                Named
            
            
                Accept pipeline input?
                False
            
        
    


    -EndpointUrl <String>
    
	The endpoint to make the call against.
	Note: This parameter is primarily for internal AWS use and is not required/should not be specified for 
    normal usage. The cmdlets normally determine which endpoint to call based on the region specified to the -Region
    parameter or set as default in the shell (via Set-DefaultAWSRegion). Only specify this parameter if you must
    direct the call to a specific custom endpoint.
	
    
        
            
                Required?
                False
            
            
                Position?
                Named
            
            
                Accept pipeline input?
                False
            
        
    









Inputs



System.String
You can pipe a String object to this cmdlet for the Name parameter.





Outputs



Amazon.LexModelBuildingService.Model.PutBotResponse
This cmdlet returns a Amazon.LexModelBuildingService.Model.PutBotResponse object containing multiple properties. The object can also be referenced from properties attached to the cmdlet entry in the $AWSHistory stack.





Related Links



Developer Guide
Service API Reference
AWS Tools for PowerShell User Guide





Supported Version



AWS Tools for PowerShell: 2.x.y.z




Link to this page
 
Did this page help you?  Yes  No   Tell us about it...

Required?	False
Position?	Named
Accept pipeline input?	False
Aliases	ClarificationPrompt_MaxAttempts