/*******************************************************************************
* 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
{
/// <summary>
/// Creates a locale in the bot. The locale contains the intents and slot types that the
/// bot uses in conversations with users in the specified language and locale. You must
/// add a locale to a bot before you can add intents and slot types to the bot.
/// </summary>
[Cmdlet("New", "LMBV2BotLocale", SupportsShouldProcess = true, ConfirmImpact = ConfirmImpact.Medium)]
[OutputType("Amazon.LexModelsV2.Model.CreateBotLocaleResponse")]
[AWSCmdlet("Calls the Amazon Lex Model Building V2 CreateBotLocale API operation.", Operation = new[] {"CreateBotLocale"}, SelectReturnType = typeof(Amazon.LexModelsV2.Model.CreateBotLocaleResponse))]
[AWSCmdletOutput("Amazon.LexModelsV2.Model.CreateBotLocaleResponse",
"This cmdlet returns an Amazon.LexModelsV2.Model.CreateBotLocaleResponse object containing multiple properties. The object can also be referenced from properties attached to the cmdlet entry in the $AWSHistory stack."
)]
public partial class NewLMBV2BotLocaleCmdlet : AmazonLexModelsV2ClientCmdlet, IExecutor
{
#region Parameter BotId
/// <summary>
/// <para>
/// <para>The identifier of the bot to create the locale for.</para>
/// </para>
/// </summary>
#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 BotId { get; set; }
#endregion
#region Parameter BotVersion
/// <summary>
/// <para>
/// <para>The version of the bot to create the locale for. This can only be the draft version
/// of the bot.</para>
/// </para>
/// </summary>
#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 BotVersion { get; set; }
#endregion
#region Parameter Description
/// <summary>
/// <para>
/// <para>A description of the bot locale. Use this to help identify the bot locale in lists.</para>
/// </para>
/// </summary>
[System.Management.Automation.Parameter(ValueFromPipelineByPropertyName = true)]
public System.String Description { get; set; }
#endregion
#region Parameter VoiceSettings_Engine
/// <summary>
/// <para>
/// <para>Indicates the type of Amazon Polly voice that Amazon Lex should use for voice interaction
/// with the user. For more information, see the <a href="https://docs.aws.amazon.com/polly/latest/dg/API_SynthesizeSpeech.html#polly-SynthesizeSpeech-request-Engine"><code>engine</code> parameter of the <code>SynthesizeSpeech</code> operation</a> in
/// the <i>Amazon Polly developer guide</i>.</para><para>If you do not specify a value, the default is <code>standard</code>.</para>
/// </para>
/// </summary>
[System.Management.Automation.Parameter(ValueFromPipelineByPropertyName = true)]
[AWSConstantClassSource("Amazon.LexModelsV2.VoiceEngine")]
public Amazon.LexModelsV2.VoiceEngine VoiceSettings_Engine { get; set; }
#endregion
#region Parameter LocaleId
/// <summary>
/// <para>
/// <para>The identifier of the language and locale that the bot will be used in. The string
/// must match one of the supported locales. All of the intents, slot types, and slots
/// used in the bot must have the same locale. For more information, see <a href="https://docs.aws.amazon.com/lexv2/latest/dg/how-languages.html">Supported
/// languages</a>.</para>
/// </para>
/// </summary>
#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 LocaleId { get; set; }
#endregion
#region Parameter NluIntentConfidenceThreshold
/// <summary>
/// <para>
/// <para>Determines the threshold where Amazon Lex will insert the <code>AMAZON.FallbackIntent</code>,
/// <code>AMAZON.KendraSearchIntent</code>, or both when returning alternative intents.
/// <code>AMAZON.FallbackIntent</code> and <code>AMAZON.KendraSearchIntent</code> are
/// only inserted if they are configured for the bot.</para><para>For example, suppose a bot is configured with the confidence threshold of 0.80 and
/// the <code>AMAZON.FallbackIntent</code>. Amazon Lex returns three alternative intents
/// with the following confidence scores: IntentA (0.70), IntentB (0.60), IntentC (0.50).
/// The response from the <code>RecognizeText</code> operation would be:</para><ul><li><para>AMAZON.FallbackIntent</para></li><li><para>IntentA</para></li><li><para>IntentB</para></li><li><para>IntentC</para></li></ul>
/// </para>
/// </summary>
#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.Double? NluIntentConfidenceThreshold { get; set; }
#endregion
#region Parameter VoiceSettings_VoiceId
/// <summary>
/// <para>
/// <para>The identifier of the Amazon Polly voice to use.</para>
/// </para>
/// </summary>
[System.Management.Automation.Parameter(ValueFromPipelineByPropertyName = true)]
public System.String VoiceSettings_VoiceId { get; set; }
#endregion
#region Parameter Select
/// <summary>
/// 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.LexModelsV2.Model.CreateBotLocaleResponse).
/// Specifying the name of a property of type Amazon.LexModelsV2.Model.CreateBotLocaleResponse will result in that property being returned.
/// Specifying -Select '^ParameterName' will result in the cmdlet returning the selected cmdlet parameter value.
/// </summary>
[System.Management.Automation.Parameter(ValueFromPipelineByPropertyName = true)]
public string Select { get; set; } = "*";
#endregion
#region Parameter PassThru
/// <summary>
/// Changes the cmdlet behavior to return the value passed to the LocaleId parameter.
/// The -PassThru parameter is deprecated, use -Select '^LocaleId' instead. This parameter will be removed in a future version.
/// </summary>
[System.Obsolete("The -PassThru parameter is deprecated, use -Select '^LocaleId' 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
/// <summary>
/// This parameter overrides confirmation prompts to force
/// the cmdlet to continue its operation. This parameter should always
/// be used with caution.
/// </summary>
[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.LocaleId), MyInvocation.BoundParameters);
if (!ConfirmShouldProceed(this.Force.IsPresent, resourceIdentifiersText, "New-LMBV2BotLocale (CreateBotLocale)"))
{
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<Amazon.LexModelsV2.Model.CreateBotLocaleResponse, NewLMBV2BotLocaleCmdlet>(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.LocaleId;
}
#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.BotVersion = this.BotVersion;
#if MODULAR
if (this.BotVersion == null && ParameterWasBound(nameof(this.BotVersion)))
{
WriteWarning("You are passing $null as a value for parameter BotVersion 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.Description = this.Description;
context.LocaleId = this.LocaleId;
#if MODULAR
if (this.LocaleId == null && ParameterWasBound(nameof(this.LocaleId)))
{
WriteWarning("You are passing $null as a value for parameter LocaleId 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;
#if MODULAR
if (this.NluIntentConfidenceThreshold == null && ParameterWasBound(nameof(this.NluIntentConfidenceThreshold)))
{
WriteWarning("You are passing $null as a value for parameter NluIntentConfidenceThreshold 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.VoiceSettings_Engine = this.VoiceSettings_Engine;
context.VoiceSettings_VoiceId = this.VoiceSettings_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.LexModelsV2.Model.CreateBotLocaleRequest();
if (cmdletContext.BotId != null)
{
request.BotId = cmdletContext.BotId;
}
if (cmdletContext.BotVersion != null)
{
request.BotVersion = cmdletContext.BotVersion;
}
if (cmdletContext.Description != null)
{
request.Description = cmdletContext.Description;
}
if (cmdletContext.LocaleId != null)
{
request.LocaleId = cmdletContext.LocaleId;
}
if (cmdletContext.NluIntentConfidenceThreshold != null)
{
request.NluIntentConfidenceThreshold = cmdletContext.NluIntentConfidenceThreshold.Value;
}
// populate VoiceSettings
var requestVoiceSettingsIsNull = true;
request.VoiceSettings = new Amazon.LexModelsV2.Model.VoiceSettings();
Amazon.LexModelsV2.VoiceEngine requestVoiceSettings_voiceSettings_Engine = null;
if (cmdletContext.VoiceSettings_Engine != null)
{
requestVoiceSettings_voiceSettings_Engine = cmdletContext.VoiceSettings_Engine;
}
if (requestVoiceSettings_voiceSettings_Engine != null)
{
request.VoiceSettings.Engine = requestVoiceSettings_voiceSettings_Engine;
requestVoiceSettingsIsNull = false;
}
System.String requestVoiceSettings_voiceSettings_VoiceId = null;
if (cmdletContext.VoiceSettings_VoiceId != null)
{
requestVoiceSettings_voiceSettings_VoiceId = cmdletContext.VoiceSettings_VoiceId;
}
if (requestVoiceSettings_voiceSettings_VoiceId != null)
{
request.VoiceSettings.VoiceId = requestVoiceSettings_voiceSettings_VoiceId;
requestVoiceSettingsIsNull = false;
}
// determine if request.VoiceSettings should be set to null
if (requestVoiceSettingsIsNull)
{
request.VoiceSettings = null;
}
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.CreateBotLocaleResponse CallAWSServiceOperation(IAmazonLexModelsV2 client, Amazon.LexModelsV2.Model.CreateBotLocaleRequest request)
{
Utils.Common.WriteVerboseEndpointMessage(this, client.Config, "Amazon Lex Model Building V2", "CreateBotLocale");
try
{
#if DESKTOP
return client.CreateBotLocale(request);
#elif CORECLR
return client.CreateBotLocaleAsync(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 BotVersion { get; set; }
public System.String Description { get; set; }
public System.String LocaleId { get; set; }
public System.Double? NluIntentConfidenceThreshold { get; set; }
public Amazon.LexModelsV2.VoiceEngine VoiceSettings_Engine { get; set; }
public System.String VoiceSettings_VoiceId { get; set; }
public System.Func<Amazon.LexModelsV2.Model.CreateBotLocaleResponse, NewLMBV2BotLocaleCmdlet, object> Select { get; set; } =
(response, cmdlet) => response;
}
}
}