/******************************************************************************* * Copyright 2012-2019 Amazon.com, Inc. or its affiliates. All Rights Reserved. * Licensed under the Apache License, Version 2.0 (the "License"). You may not use * this file except in compliance with the License. A copy of the License is located at * * http://aws.amazon.com/apache2.0 * * or in the "license" file accompanying this file. * This file is distributed on an "AS IS" BASIS, WITHOUT WARRANTIES OR * CONDITIONS OF ANY KIND, either express or implied. See the License for the * specific language governing permissions and limitations under the License. * ***************************************************************************** * * AWS Tools for Windows (TM) PowerShell (TM) * */ using System; using System.Collections.Generic; using System.Linq; using System.Management.Automation; using System.Text; using Amazon.PowerShell.Common; using Amazon.Runtime; using Amazon.LexModelBuildingService; using Amazon.LexModelBuildingService.Model; namespace Amazon.PowerShell.Cmdlets.LMB { /// /// 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 security-iam. /// /// [Cmdlet("Write", "LMBBot", SupportsShouldProcess = true, ConfirmImpact = ConfirmImpact.Medium)] [OutputType("Amazon.LexModelBuildingService.Model.PutBotResponse")] [AWSCmdlet("Calls the Amazon Lex Model Building Service PutBot API operation.", Operation = new[] {"PutBot"}, SelectReturnType = typeof(Amazon.LexModelBuildingService.Model.PutBotResponse))] [AWSCmdletOutput("Amazon.LexModelBuildingService.Model.PutBotResponse", "This cmdlet returns an 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." )] public partial class WriteLMBBotCmdlet : AmazonLexModelBuildingServiceClientCmdlet, IExecutor { #region Parameter AbortStatement /// /// /// 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 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. /// /// [System.Management.Automation.Parameter(ValueFromPipelineByPropertyName = true)] public Amazon.LexModelBuildingService.Model.Statement AbortStatement { get; set; } #endregion #region Parameter Checksum /// /// /// 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. /// /// [System.Management.Automation.Parameter(ValueFromPipelineByPropertyName = true)] public System.String Checksum { get; set; } #endregion #region Parameter 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. /// /// #if !MODULAR [System.Management.Automation.Parameter(ValueFromPipelineByPropertyName = true)] #else [System.Management.Automation.Parameter(ValueFromPipelineByPropertyName = true, Mandatory = true)] [System.Management.Automation.AllowNull] #endif [Amazon.PowerShell.Common.AWSRequiredParameter] public System.Boolean? ChildDirected { get; set; } #endregion #region Parameter CreateVersion /// /// /// When set to 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. /// /// [System.Management.Automation.Parameter(ValueFromPipelineByPropertyName = true)] public System.Boolean? CreateVersion { get; set; } #endregion #region Parameter Description /// /// /// A description of the bot. /// /// [System.Management.Automation.Parameter(ValueFromPipelineByPropertyName = true)] public System.String Description { get; set; } #endregion #region Parameter DetectSentiment /// /// /// When set to true user utterances are sent to Amazon Comprehend for sentiment /// analysis. If you don't specify detectSentiment, the default is false. /// /// [System.Management.Automation.Parameter(ValueFromPipelineByPropertyName = true)] public System.Boolean? DetectSentiment { get; set; } #endregion #region Parameter EnableModelImprovement /// /// /// Set to 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:
  • US East (N. Virginia) (us-east-1)
  • US West (Oregon) (us-west-2)
  • Asia Pacific (Sydney) (ap-southeast-2)
  • EU (Ireland) (eu-west-1)
In other Regions, the enableModelImprovements parameter is set to true /// by default. In these Regions setting the parameter to false throws a /// ValidationException exception. /// /// [System.Management.Automation.Parameter(ValueFromPipelineByPropertyName = true)] [Alias("EnableModelImprovements")] public System.Boolean? EnableModelImprovement { get; set; } #endregion #region Parameter IdleSessionTTLInSecond /// /// /// 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). /// /// [System.Management.Automation.Parameter(ValueFromPipelineByPropertyName = true)] [Alias("IdleSessionTTLInSeconds")] public System.Int32? IdleSessionTTLInSecond { get; set; } #endregion #region Parameter 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. /// /// [System.Management.Automation.Parameter(ValueFromPipelineByPropertyName = true)] [Alias("Intents")] public Amazon.LexModelBuildingService.Model.Intent[] Intent { get; set; } #endregion #region Parameter 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. /// /// #if !MODULAR [System.Management.Automation.Parameter(ValueFromPipelineByPropertyName = true)] #else [System.Management.Automation.Parameter(ValueFromPipelineByPropertyName = true, Mandatory = true)] [System.Management.Automation.AllowNull] #endif [Amazon.PowerShell.Common.AWSRequiredParameter] [AWSConstantClassSource("Amazon.LexModelBuildingService.Locale")] public Amazon.LexModelBuildingService.Locale Locale { get; set; } #endregion #region Parameter ClarificationPrompt_MaxAttempt /// /// /// The number of times to prompt the user for information. /// /// [System.Management.Automation.Parameter(ValueFromPipelineByPropertyName = true)] [Alias("ClarificationPrompt_MaxAttempts")] public System.Int32? ClarificationPrompt_MaxAttempt { get; set; } #endregion #region Parameter ClarificationPrompt_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). /// /// [System.Management.Automation.Parameter(ValueFromPipelineByPropertyName = true)] [Alias("ClarificationPrompt_Messages")] public Amazon.LexModelBuildingService.Model.Message[] ClarificationPrompt_Message { get; set; } #endregion #region Parameter Name /// /// /// The name of the bot. The name is not case sensitive. /// /// #if !MODULAR [System.Management.Automation.Parameter(Position = 0, ValueFromPipelineByPropertyName = true, ValueFromPipeline = true)] #else [System.Management.Automation.Parameter(Position = 0, ValueFromPipelineByPropertyName = true, ValueFromPipeline = true, Mandatory = true)] [System.Management.Automation.AllowEmptyString] [System.Management.Automation.AllowNull] #endif [Amazon.PowerShell.Common.AWSRequiredParameter] public System.String Name { get; set; } #endregion #region Parameter NluIntentConfidenceThreshold /// /// /// Determines the threshold where Amazon Lex will insert the 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.
  • US East (N. Virginia) (us-east-1)
  • US West (Oregon) (us-west-2)
  • Asia Pacific (Sydney) (ap-southeast-2)
  • EU (Ireland) (eu-west-1)
In other Regions, the 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:
  • AMAZON.FallbackIntent
  • IntentA
  • IntentB
  • IntentC
/// /// [System.Management.Automation.Parameter(ValueFromPipelineByPropertyName = true)] public System.Double? NluIntentConfidenceThreshold { get; set; } #endregion #region Parameter 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. /// /// [System.Management.Automation.Parameter(ValueFromPipelineByPropertyName = true)] [AWSConstantClassSource("Amazon.LexModelBuildingService.ProcessBehavior")] public Amazon.LexModelBuildingService.ProcessBehavior ProcessBehavior { get; set; } #endregion #region Parameter ClarificationPrompt_ResponseCard /// /// /// 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. /// /// [System.Management.Automation.Parameter(ValueFromPipelineByPropertyName = true)] public System.String ClarificationPrompt_ResponseCard { get; set; } #endregion #region Parameter Tag /// /// /// A list of tags to add to the bot. You can only add tags when you create a bot, you /// can't use the PutBot operation to update the tags on a bot. To update /// tags, use the TagResource operation. /// /// [System.Management.Automation.Parameter(ValueFromPipelineByPropertyName = true)] [Alias("Tags")] public Amazon.LexModelBuildingService.Model.Tag[] Tag { get; set; } #endregion #region Parameter VoiceId /// /// /// 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 Voices /// in Amazon Polly in the Amazon Polly Developer Guide. /// /// [System.Management.Automation.Parameter(ValueFromPipelineByPropertyName = true)] public System.String VoiceId { get; set; } #endregion #region Parameter Select /// /// Use the -Select parameter to control the cmdlet output. The default value is '*'. /// Specifying -Select '*' will result in the cmdlet returning the whole service response (Amazon.LexModelBuildingService.Model.PutBotResponse). /// Specifying the name of a property of type Amazon.LexModelBuildingService.Model.PutBotResponse will result in that property being returned. /// Specifying -Select '^ParameterName' will result in the cmdlet returning the selected cmdlet parameter value. /// [System.Management.Automation.Parameter(ValueFromPipelineByPropertyName = true)] public string Select { get; set; } = "*"; #endregion #region Parameter PassThru /// /// Changes the cmdlet behavior to return the value passed to the Name parameter. /// The -PassThru parameter is deprecated, use -Select '^Name' instead. This parameter will be removed in a future version. /// [System.Obsolete("The -PassThru parameter is deprecated, use -Select '^Name' instead. This parameter will be removed in a future version.")] [System.Management.Automation.Parameter(ValueFromPipelineByPropertyName = true)] public SwitchParameter PassThru { get; set; } #endregion #region Parameter Force /// /// This parameter overrides confirmation prompts to force /// the cmdlet to continue its operation. This parameter should always /// be used with caution. /// [System.Management.Automation.Parameter(ValueFromPipelineByPropertyName = true)] public SwitchParameter Force { get; set; } #endregion protected override void ProcessRecord() { this._AWSSignerType = "v4"; base.ProcessRecord(); var resourceIdentifiersText = FormatParameterValuesForConfirmationMsg(nameof(this.Name), MyInvocation.BoundParameters); if (!ConfirmShouldProceed(this.Force.IsPresent, resourceIdentifiersText, "Write-LMBBot (PutBot)")) { return; } var context = new CmdletContext(); // allow for manipulation of parameters prior to loading into context PreExecutionContextLoad(context); #pragma warning disable CS0618, CS0612 //A class member was marked with the Obsolete attribute if (ParameterWasBound(nameof(this.Select))) { context.Select = CreateSelectDelegate(Select) ?? throw new System.ArgumentException("Invalid value for -Select parameter.", nameof(this.Select)); if (this.PassThru.IsPresent) { throw new System.ArgumentException("-PassThru cannot be used when -Select is specified.", nameof(this.Select)); } } else if (this.PassThru.IsPresent) { context.Select = (response, cmdlet) => this.Name; } #pragma warning restore CS0618, CS0612 //A class member was marked with the Obsolete attribute context.AbortStatement = this.AbortStatement; context.Checksum = this.Checksum; context.ChildDirected = this.ChildDirected; #if MODULAR if (this.ChildDirected == null && ParameterWasBound(nameof(this.ChildDirected))) { WriteWarning("You are passing $null as a value for parameter ChildDirected which is marked as required. In case you believe this parameter was incorrectly marked as required, report this by opening an issue at https://github.com/aws/aws-tools-for-powershell/issues."); } #endif context.ClarificationPrompt_MaxAttempt = this.ClarificationPrompt_MaxAttempt; if (this.ClarificationPrompt_Message != null) { context.ClarificationPrompt_Message = new List(this.ClarificationPrompt_Message); } context.ClarificationPrompt_ResponseCard = this.ClarificationPrompt_ResponseCard; context.CreateVersion = this.CreateVersion; context.Description = this.Description; context.DetectSentiment = this.DetectSentiment; context.EnableModelImprovement = this.EnableModelImprovement; context.IdleSessionTTLInSecond = this.IdleSessionTTLInSecond; if (this.Intent != null) { context.Intent = new List(this.Intent); } context.Locale = this.Locale; #if MODULAR if (this.Locale == null && ParameterWasBound(nameof(this.Locale))) { WriteWarning("You are passing $null as a value for parameter Locale which is marked as required. In case you believe this parameter was incorrectly marked as required, report this by opening an issue at https://github.com/aws/aws-tools-for-powershell/issues."); } #endif context.Name = this.Name; #if MODULAR if (this.Name == null && ParameterWasBound(nameof(this.Name))) { WriteWarning("You are passing $null as a value for parameter Name which is marked as required. In case you believe this parameter was incorrectly marked as required, report this by opening an issue at https://github.com/aws/aws-tools-for-powershell/issues."); } #endif context.NluIntentConfidenceThreshold = this.NluIntentConfidenceThreshold; context.ProcessBehavior = this.ProcessBehavior; if (this.Tag != null) { context.Tag = new List(this.Tag); } context.VoiceId = this.VoiceId; // allow further manipulation of loaded context prior to processing PostExecutionContextLoad(context); var output = Execute(context) as CmdletOutput; ProcessOutput(output); } #region IExecutor Members public object Execute(ExecutorContext context) { var cmdletContext = context as CmdletContext; // create request var request = new Amazon.LexModelBuildingService.Model.PutBotRequest(); if (cmdletContext.AbortStatement != null) { request.AbortStatement = cmdletContext.AbortStatement; } if (cmdletContext.Checksum != null) { request.Checksum = cmdletContext.Checksum; } if (cmdletContext.ChildDirected != null) { request.ChildDirected = cmdletContext.ChildDirected.Value; } // populate ClarificationPrompt var requestClarificationPromptIsNull = true; request.ClarificationPrompt = new Amazon.LexModelBuildingService.Model.Prompt(); System.Int32? requestClarificationPrompt_clarificationPrompt_MaxAttempt = null; if (cmdletContext.ClarificationPrompt_MaxAttempt != null) { requestClarificationPrompt_clarificationPrompt_MaxAttempt = cmdletContext.ClarificationPrompt_MaxAttempt.Value; } if (requestClarificationPrompt_clarificationPrompt_MaxAttempt != null) { request.ClarificationPrompt.MaxAttempts = requestClarificationPrompt_clarificationPrompt_MaxAttempt.Value; requestClarificationPromptIsNull = false; } List requestClarificationPrompt_clarificationPrompt_Message = null; if (cmdletContext.ClarificationPrompt_Message != null) { requestClarificationPrompt_clarificationPrompt_Message = cmdletContext.ClarificationPrompt_Message; } if (requestClarificationPrompt_clarificationPrompt_Message != null) { request.ClarificationPrompt.Messages = requestClarificationPrompt_clarificationPrompt_Message; requestClarificationPromptIsNull = false; } System.String requestClarificationPrompt_clarificationPrompt_ResponseCard = null; if (cmdletContext.ClarificationPrompt_ResponseCard != null) { requestClarificationPrompt_clarificationPrompt_ResponseCard = cmdletContext.ClarificationPrompt_ResponseCard; } if (requestClarificationPrompt_clarificationPrompt_ResponseCard != null) { request.ClarificationPrompt.ResponseCard = requestClarificationPrompt_clarificationPrompt_ResponseCard; requestClarificationPromptIsNull = false; } // determine if request.ClarificationPrompt should be set to null if (requestClarificationPromptIsNull) { request.ClarificationPrompt = null; } if (cmdletContext.CreateVersion != null) { request.CreateVersion = cmdletContext.CreateVersion.Value; } if (cmdletContext.Description != null) { request.Description = cmdletContext.Description; } if (cmdletContext.DetectSentiment != null) { request.DetectSentiment = cmdletContext.DetectSentiment.Value; } if (cmdletContext.EnableModelImprovement != null) { request.EnableModelImprovements = cmdletContext.EnableModelImprovement.Value; } if (cmdletContext.IdleSessionTTLInSecond != null) { request.IdleSessionTTLInSeconds = cmdletContext.IdleSessionTTLInSecond.Value; } if (cmdletContext.Intent != null) { request.Intents = cmdletContext.Intent; } if (cmdletContext.Locale != null) { request.Locale = cmdletContext.Locale; } if (cmdletContext.Name != null) { request.Name = cmdletContext.Name; } if (cmdletContext.NluIntentConfidenceThreshold != null) { request.NluIntentConfidenceThreshold = cmdletContext.NluIntentConfidenceThreshold.Value; } if (cmdletContext.ProcessBehavior != null) { request.ProcessBehavior = cmdletContext.ProcessBehavior; } if (cmdletContext.Tag != null) { request.Tags = cmdletContext.Tag; } if (cmdletContext.VoiceId != null) { request.VoiceId = cmdletContext.VoiceId; } CmdletOutput output; // issue call var client = Client ?? CreateClient(_CurrentCredentials, _RegionEndpoint); try { var response = CallAWSServiceOperation(client, request); object pipelineOutput = null; pipelineOutput = cmdletContext.Select(response, this); output = new CmdletOutput { PipelineOutput = pipelineOutput, ServiceResponse = response }; } catch (Exception e) { output = new CmdletOutput { ErrorResponse = e }; } return output; } public ExecutorContext CreateContext() { return new CmdletContext(); } #endregion #region AWS Service Operation Call private Amazon.LexModelBuildingService.Model.PutBotResponse CallAWSServiceOperation(IAmazonLexModelBuildingService client, Amazon.LexModelBuildingService.Model.PutBotRequest request) { Utils.Common.WriteVerboseEndpointMessage(this, client.Config, "Amazon Lex Model Building Service", "PutBot"); try { #if DESKTOP return client.PutBot(request); #elif CORECLR return client.PutBotAsync(request).GetAwaiter().GetResult(); #else #error "Unknown build edition" #endif } catch (AmazonServiceException exc) { var webException = exc.InnerException as System.Net.WebException; if (webException != null) { throw new Exception(Utils.Common.FormatNameResolutionFailureMessage(client.Config, webException.Message), webException); } throw; } } #endregion internal partial class CmdletContext : ExecutorContext { public Amazon.LexModelBuildingService.Model.Statement AbortStatement { get; set; } public System.String Checksum { get; set; } public System.Boolean? ChildDirected { get; set; } public System.Int32? ClarificationPrompt_MaxAttempt { get; set; } public List ClarificationPrompt_Message { get; set; } public System.String ClarificationPrompt_ResponseCard { get; set; } public System.Boolean? CreateVersion { get; set; } public System.String Description { get; set; } public System.Boolean? DetectSentiment { get; set; } public System.Boolean? EnableModelImprovement { get; set; } public System.Int32? IdleSessionTTLInSecond { get; set; } public List Intent { get; set; } public Amazon.LexModelBuildingService.Locale Locale { get; set; } public System.String Name { get; set; } public System.Double? NluIntentConfidenceThreshold { get; set; } public Amazon.LexModelBuildingService.ProcessBehavior ProcessBehavior { get; set; } public List Tag { get; set; } public System.String VoiceId { get; set; } public System.Func Select { get; set; } = (response, cmdlet) => response; } } }