/******************************************************************************* * 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.LexModelsV2; using Amazon.LexModelsV2.Model; namespace Amazon.PowerShell.Cmdlets.LMBV2 { /// /// Deletes stored utterances. /// /// /// /// Amazon Lex stores the utterances that users send to your bot. Utterances are stored /// for 15 days for use with the ListAggregatedUtterances /// operation, and then stored indefinitely for use in improving the ability of your bot /// to respond to user input.. /// /// Use the DeleteUtterances operation to manually delete utterances for /// a specific session. When you use the DeleteUtterances operation, utterances /// stored for improving your bot's ability to respond to user input are deleted immediately. /// Utterances stored for use with the ListAggregatedUtterances operation /// are deleted after 15 days. /// /// [Cmdlet("Remove", "LMBV2Utterance", SupportsShouldProcess = true, ConfirmImpact = ConfirmImpact.High)] [OutputType("None")] [AWSCmdlet("Calls the Amazon Lex Model Building V2 DeleteUtterances API operation.", Operation = new[] {"DeleteUtterances"}, SelectReturnType = typeof(Amazon.LexModelsV2.Model.DeleteUtterancesResponse))] [AWSCmdletOutput("None or Amazon.LexModelsV2.Model.DeleteUtterancesResponse", "This cmdlet does not generate any output." + "The service response (type Amazon.LexModelsV2.Model.DeleteUtterancesResponse) can be referenced from properties attached to the cmdlet entry in the $AWSHistory stack." )] public partial class RemoveLMBV2UtteranceCmdlet : AmazonLexModelsV2ClientCmdlet, IExecutor { #region Parameter BotId /// /// /// The unique identifier of the bot that contains the utterances. /// /// #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 BotId { get; set; } #endregion #region Parameter LocaleId /// /// /// The identifier of the language and locale where the utterances were collected. The /// string must match one of the supported locales. For more information, see Supported /// languages. /// /// [System.Management.Automation.Parameter(ValueFromPipelineByPropertyName = true)] public System.String LocaleId { get; set; } #endregion #region Parameter SessionId /// /// /// The unique identifier of the session with the user. The ID is returned in the response /// from the RecognizeText /// and RecognizeUtterance /// operations. /// /// [System.Management.Automation.Parameter(ValueFromPipelineByPropertyName = true)] public System.String SessionId { get; set; } #endregion #region Parameter Select /// /// Use the -Select parameter to control the cmdlet output. The cmdlet doesn't have a return value by default. /// Specifying -Select '*' will result in the cmdlet returning the whole service response (Amazon.LexModelsV2.Model.DeleteUtterancesResponse). /// 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 BotId parameter. /// The -PassThru parameter is deprecated, use -Select '^BotId' instead. This parameter will be removed in a future version. /// [System.Obsolete("The -PassThru parameter is deprecated, use -Select '^BotId' 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.BotId), MyInvocation.BoundParameters); if (!ConfirmShouldProceed(this.Force.IsPresent, resourceIdentifiersText, "Remove-LMBV2Utterance (DeleteUtterances)")) { 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.BotId; } #pragma warning restore CS0618, CS0612 //A class member was marked with the Obsolete attribute context.BotId = this.BotId; #if MODULAR if (this.BotId == null && ParameterWasBound(nameof(this.BotId))) { WriteWarning("You are passing $null as a value for parameter BotId 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.LocaleId = this.LocaleId; context.SessionId = this.SessionId; // 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.LexModelsV2.Model.DeleteUtterancesRequest(); if (cmdletContext.BotId != null) { request.BotId = cmdletContext.BotId; } if (cmdletContext.LocaleId != null) { request.LocaleId = cmdletContext.LocaleId; } if (cmdletContext.SessionId != null) { request.SessionId = cmdletContext.SessionId; } 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.LexModelsV2.Model.DeleteUtterancesResponse CallAWSServiceOperation(IAmazonLexModelsV2 client, Amazon.LexModelsV2.Model.DeleteUtterancesRequest request) { Utils.Common.WriteVerboseEndpointMessage(this, client.Config, "Amazon Lex Model Building V2", "DeleteUtterances"); try { #if DESKTOP return client.DeleteUtterances(request); #elif CORECLR return client.DeleteUtterancesAsync(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 System.String BotId { get; set; } public System.String LocaleId { get; set; } public System.String SessionId { get; set; } public System.Func Select { get; set; } = (response, cmdlet) => null; } } }