/******************************************************************************* * 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.Lex; using Amazon.Lex.Model; namespace Amazon.PowerShell.Cmdlets.LEX { /// /// Sends user input to Amazon Lex. Client applications can use this API to send requests /// to Amazon Lex at runtime. Amazon Lex then interprets the user input using the machine /// learning model it built for the bot. /// /// /// /// In response, Amazon Lex returns the next message to convey to the user /// an optional responseCard to display. Consider the following example messages: /// /// /// Not all Amazon Lex messages require a user response. For example, a conclusion statement /// does not require a response. Some messages require only a "yes" or "no" user response. /// In addition to the message, Amazon Lex provides additional context about /// the message in the response that you might use to enhance client behavior, for example, /// to display the appropriate client user interface. These are the slotToElicit, /// dialogState, intentName, and slots fields in /// the response. Consider the following examples: /// /// In addition, Amazon Lex also returns your application-specific sessionAttributes. /// For more information, see Managing /// Conversation Context. /// /// [Cmdlet("Send", "LEXText")] [OutputType("Amazon.Lex.Model.PostTextResponse")] [AWSCmdlet("Calls the Amazon Lex PostText API operation.", Operation = new[] {"PostText"}, SelectReturnType = typeof(Amazon.Lex.Model.PostTextResponse))] [AWSCmdletOutput("Amazon.Lex.Model.PostTextResponse", "This cmdlet returns an Amazon.Lex.Model.PostTextResponse object containing multiple properties. The object can also be referenced from properties attached to the cmdlet entry in the $AWSHistory stack." )] public partial class SendLEXTextCmdlet : AmazonLexClientCmdlet, IExecutor { protected override bool IsSensitiveRequest { get; set; } = true; protected override bool IsSensitiveResponse { get; set; } = true; #region Parameter ActiveContext /// /// /// A list of contexts active for the request. A context can be activated when a previous /// intent is fulfilled, or by including the context in the request,If you don't specify a list of contexts, Amazon Lex will use the current list of contexts /// for the session. If you specify an empty list, all contexts for the session are cleared. /// /// [System.Management.Automation.Parameter(ValueFromPipelineByPropertyName = true)] [Alias("ActiveContexts")] public Amazon.Lex.Model.ActiveContext[] ActiveContext { get; set; } #endregion #region Parameter BotAlias /// /// /// The alias of the Amazon Lex bot. /// /// #if !MODULAR [System.Management.Automation.Parameter(ValueFromPipelineByPropertyName = true)] #else [System.Management.Automation.Parameter(ValueFromPipelineByPropertyName = true, Mandatory = true)] [System.Management.Automation.AllowEmptyString] [System.Management.Automation.AllowNull] #endif [Amazon.PowerShell.Common.AWSRequiredParameter] public System.String BotAlias { get; set; } #endregion #region Parameter BotName /// /// /// The name of the Amazon Lex bot. /// /// #if !MODULAR [System.Management.Automation.Parameter(ValueFromPipelineByPropertyName = true)] #else [System.Management.Automation.Parameter(ValueFromPipelineByPropertyName = true, Mandatory = true)] [System.Management.Automation.AllowEmptyString] [System.Management.Automation.AllowNull] #endif [Amazon.PowerShell.Common.AWSRequiredParameter] public System.String BotName { get; set; } #endregion #region Parameter InputText /// /// /// The text that the user entered (Amazon Lex interprets this text). /// /// #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 InputText { get; set; } #endregion #region Parameter RequestAttribute /// /// /// Request-specific information passed between Amazon Lex and a client application.The namespace x-amz-lex: is reserved for special attributes. Don't create /// any request attributes with the prefix x-amz-lex:.For more information, see Setting /// Request Attributes. /// /// [System.Management.Automation.Parameter(ValueFromPipelineByPropertyName = true)] [Alias("RequestAttributes")] public System.Collections.Hashtable RequestAttribute { get; set; } #endregion #region Parameter SessionAttribute /// /// /// Application-specific information passed between Amazon Lex and a client application.For more information, see Setting /// Session Attributes. /// /// [System.Management.Automation.Parameter(ValueFromPipelineByPropertyName = true)] [Alias("SessionAttributes")] public System.Collections.Hashtable SessionAttribute { get; set; } #endregion #region Parameter UserId /// /// /// The ID of the client application user. Amazon Lex uses this to identify a user's conversation /// with your bot. At runtime, each request must contain the userID field.To decide the user ID to use for your application, consider the following factors. /// /// #if !MODULAR [System.Management.Automation.Parameter(ValueFromPipelineByPropertyName = true)] #else [System.Management.Automation.Parameter(ValueFromPipelineByPropertyName = true, Mandatory = true)] [System.Management.Automation.AllowEmptyString] [System.Management.Automation.AllowNull] #endif [Amazon.PowerShell.Common.AWSRequiredParameter] public System.String UserId { 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.Lex.Model.PostTextResponse). /// Specifying the name of a property of type Amazon.Lex.Model.PostTextResponse 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 InputText parameter. /// The -PassThru parameter is deprecated, use -Select '^InputText' instead. This parameter will be removed in a future version. /// [System.Obsolete("The -PassThru parameter is deprecated, use -Select '^InputText' instead. This parameter will be removed in a future version.")] [System.Management.Automation.Parameter(ValueFromPipelineByPropertyName = true)] public SwitchParameter PassThru { get; set; } #endregion protected override void ProcessRecord() { this._AWSSignerType = "v4"; base.ProcessRecord(); 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.InputText; } #pragma warning restore CS0618, CS0612 //A class member was marked with the Obsolete attribute if (this.ActiveContext != null) { context.ActiveContext = new List(this.ActiveContext); } context.BotAlias = this.BotAlias; #if MODULAR if (this.BotAlias == null && ParameterWasBound(nameof(this.BotAlias))) { WriteWarning("You are passing $null as a value for parameter BotAlias 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.BotName = this.BotName; #if MODULAR if (this.BotName == null && ParameterWasBound(nameof(this.BotName))) { WriteWarning("You are passing $null as a value for parameter BotName 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.InputText = this.InputText; #if MODULAR if (this.InputText == null && ParameterWasBound(nameof(this.InputText))) { WriteWarning("You are passing $null as a value for parameter InputText 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 if (this.RequestAttribute != null) { context.RequestAttribute = new Dictionary(StringComparer.Ordinal); foreach (var hashKey in this.RequestAttribute.Keys) { context.RequestAttribute.Add((String)hashKey, (String)(this.RequestAttribute[hashKey])); } } if (this.SessionAttribute != null) { context.SessionAttribute = new Dictionary(StringComparer.Ordinal); foreach (var hashKey in this.SessionAttribute.Keys) { context.SessionAttribute.Add((String)hashKey, (String)(this.SessionAttribute[hashKey])); } } context.UserId = this.UserId; #if MODULAR if (this.UserId == null && ParameterWasBound(nameof(this.UserId))) { WriteWarning("You are passing $null as a value for parameter UserId 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 // 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.Lex.Model.PostTextRequest(); if (cmdletContext.ActiveContext != null) { request.ActiveContexts = cmdletContext.ActiveContext; } if (cmdletContext.BotAlias != null) { request.BotAlias = cmdletContext.BotAlias; } if (cmdletContext.BotName != null) { request.BotName = cmdletContext.BotName; } if (cmdletContext.InputText != null) { request.InputText = cmdletContext.InputText; } if (cmdletContext.RequestAttribute != null) { request.RequestAttributes = cmdletContext.RequestAttribute; } if (cmdletContext.SessionAttribute != null) { request.SessionAttributes = cmdletContext.SessionAttribute; } if (cmdletContext.UserId != null) { request.UserId = cmdletContext.UserId; } 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.Lex.Model.PostTextResponse CallAWSServiceOperation(IAmazonLex client, Amazon.Lex.Model.PostTextRequest request) { Utils.Common.WriteVerboseEndpointMessage(this, client.Config, "Amazon Lex", "PostText"); try { #if DESKTOP return client.PostText(request); #elif CORECLR return client.PostTextAsync(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 List ActiveContext { get; set; } public System.String BotAlias { get; set; } public System.String BotName { get; set; } public System.String InputText { get; set; } public Dictionary RequestAttribute { get; set; } public Dictionary SessionAttribute { get; set; } public System.String UserId { get; set; } public System.Func Select { get; set; } = (response, cmdlet) => response; } } }