/*******************************************************************************
* 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 alias for the specified version of the bot or replaces an alias for the
/// specified bot. To change the version of the bot that the alias points to, replace
/// the alias. For more information about aliases, see versioning-aliases.
///
///
///
/// This operation requires permissions for the lex:PutBotAlias
action.
///
///
[Cmdlet("Write", "LMBBotAlias", SupportsShouldProcess = true, ConfirmImpact = ConfirmImpact.Medium)]
[OutputType("Amazon.LexModelBuildingService.Model.PutBotAliasResponse")]
[AWSCmdlet("Calls the Amazon Lex Model Building Service PutBotAlias API operation.", Operation = new[] {"PutBotAlias"}, SelectReturnType = typeof(Amazon.LexModelBuildingService.Model.PutBotAliasResponse))]
[AWSCmdletOutput("Amazon.LexModelBuildingService.Model.PutBotAliasResponse",
"This cmdlet returns an Amazon.LexModelBuildingService.Model.PutBotAliasResponse object containing multiple properties. The object can also be referenced from properties attached to the cmdlet entry in the $AWSHistory stack."
)]
public partial class WriteLMBBotAliasCmdlet : AmazonLexModelBuildingServiceClientCmdlet, IExecutor
{
#region Parameter BotName
///
///
/// The name of the 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 BotVersion
///
///
/// The version of the 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 BotVersion { get; set; }
#endregion
#region Parameter Checksum
///
///
/// Identifies a specific revision of the $LATEST
version.When you create a new bot alias, leave the checksum
field blank. If you
/// specify a checksum you get a BadRequestException
exception.When you want to update a bot alias, 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 Description
///
///
/// A description of the alias.
///
///
[System.Management.Automation.Parameter(ValueFromPipelineByPropertyName = true)]
public System.String Description { get; set; }
#endregion
#region Parameter ConversationLogs_IamRoleArn
///
///
/// The Amazon Resource Name (ARN) of an IAM role with permission to write to your CloudWatch
/// Logs for text logs and your S3 bucket for audio logs. If audio encryption is enabled,
/// this role also provides access permission for the AWS KMS key used for encrypting
/// audio logs. For more information, see Creating
/// an IAM Role and Policy for Conversation Logs.
///
///
[System.Management.Automation.Parameter(ValueFromPipelineByPropertyName = true)]
public System.String ConversationLogs_IamRoleArn { get; set; }
#endregion
#region Parameter ConversationLogs_LogSetting
///
///
/// The settings for your conversation logs. You can log the conversation text, conversation
/// audio, or both.
///
///
[System.Management.Automation.Parameter(ValueFromPipelineByPropertyName = true)]
[Alias("ConversationLogs_LogSettings")]
public Amazon.LexModelBuildingService.Model.LogSettingsRequest[] ConversationLogs_LogSetting { get; set; }
#endregion
#region Parameter Name
///
///
/// The name of the alias. 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 Tag
///
///
/// A list of tags to add to the bot alias. You can only add tags when you create an alias,
/// you can't use the PutBotAlias
operation to update the tags on a bot alias.
/// 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 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.PutBotAliasResponse).
/// Specifying the name of a property of type Amazon.LexModelBuildingService.Model.PutBotAliasResponse 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-LMBBotAlias (PutBotAlias)"))
{
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.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.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.Checksum = this.Checksum;
context.ConversationLogs_IamRoleArn = this.ConversationLogs_IamRoleArn;
if (this.ConversationLogs_LogSetting != null)
{
context.ConversationLogs_LogSetting = new List(this.ConversationLogs_LogSetting);
}
context.Description = this.Description;
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
if (this.Tag != null)
{
context.Tag = new List(this.Tag);
}
// 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.PutBotAliasRequest();
if (cmdletContext.BotName != null)
{
request.BotName = cmdletContext.BotName;
}
if (cmdletContext.BotVersion != null)
{
request.BotVersion = cmdletContext.BotVersion;
}
if (cmdletContext.Checksum != null)
{
request.Checksum = cmdletContext.Checksum;
}
// populate ConversationLogs
var requestConversationLogsIsNull = true;
request.ConversationLogs = new Amazon.LexModelBuildingService.Model.ConversationLogsRequest();
System.String requestConversationLogs_conversationLogs_IamRoleArn = null;
if (cmdletContext.ConversationLogs_IamRoleArn != null)
{
requestConversationLogs_conversationLogs_IamRoleArn = cmdletContext.ConversationLogs_IamRoleArn;
}
if (requestConversationLogs_conversationLogs_IamRoleArn != null)
{
request.ConversationLogs.IamRoleArn = requestConversationLogs_conversationLogs_IamRoleArn;
requestConversationLogsIsNull = false;
}
List requestConversationLogs_conversationLogs_LogSetting = null;
if (cmdletContext.ConversationLogs_LogSetting != null)
{
requestConversationLogs_conversationLogs_LogSetting = cmdletContext.ConversationLogs_LogSetting;
}
if (requestConversationLogs_conversationLogs_LogSetting != null)
{
request.ConversationLogs.LogSettings = requestConversationLogs_conversationLogs_LogSetting;
requestConversationLogsIsNull = false;
}
// determine if request.ConversationLogs should be set to null
if (requestConversationLogsIsNull)
{
request.ConversationLogs = null;
}
if (cmdletContext.Description != null)
{
request.Description = cmdletContext.Description;
}
if (cmdletContext.Name != null)
{
request.Name = cmdletContext.Name;
}
if (cmdletContext.Tag != null)
{
request.Tags = cmdletContext.Tag;
}
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.PutBotAliasResponse CallAWSServiceOperation(IAmazonLexModelBuildingService client, Amazon.LexModelBuildingService.Model.PutBotAliasRequest request)
{
Utils.Common.WriteVerboseEndpointMessage(this, client.Config, "Amazon Lex Model Building Service", "PutBotAlias");
try
{
#if DESKTOP
return client.PutBotAlias(request);
#elif CORECLR
return client.PutBotAliasAsync(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 BotName { get; set; }
public System.String BotVersion { get; set; }
public System.String Checksum { get; set; }
public System.String ConversationLogs_IamRoleArn { get; set; }
public List ConversationLogs_LogSetting { get; set; }
public System.String Description { get; set; }
public System.String Name { get; set; }
public List Tag { get; set; }
public System.Func Select { get; set; } =
(response, cmdlet) => response;
}
}
}