/******************************************************************************* * 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.Kendra; using Amazon.Kendra.Model; namespace Amazon.PowerShell.Cmdlets.KNDR { /// /// Creates a set of frequently ask questions (FAQs) using a specified FAQ file stored /// in an Amazon S3 bucket. /// /// /// /// Adding FAQs to an index is an asynchronous operation. /// /// For an example of adding an FAQ to an index using Python and Java SDKs, see Using /// your FAQ file. /// /// [Cmdlet("New", "KNDRFaq", SupportsShouldProcess = true, ConfirmImpact = ConfirmImpact.Medium)] [OutputType("System.String")] [AWSCmdlet("Calls the Amazon Kendra CreateFaq API operation.", Operation = new[] {"CreateFaq"}, SelectReturnType = typeof(Amazon.Kendra.Model.CreateFaqResponse))] [AWSCmdletOutput("System.String or Amazon.Kendra.Model.CreateFaqResponse", "This cmdlet returns a System.String object.", "The service call response (type Amazon.Kendra.Model.CreateFaqResponse) can also be referenced from properties attached to the cmdlet entry in the $AWSHistory stack." )] public partial class NewKNDRFaqCmdlet : AmazonKendraClientCmdlet, IExecutor { #region Parameter S3Path_Bucket /// /// /// The name of the S3 bucket that contains the file. /// /// #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 S3Path_Bucket { get; set; } #endregion #region Parameter Description /// /// /// A description for the FAQ. /// /// [System.Management.Automation.Parameter(ValueFromPipelineByPropertyName = true)] public System.String Description { get; set; } #endregion #region Parameter FileFormat /// /// /// The format of the FAQ input file. You can choose between a basic CSV format, a CSV /// format that includes customs attributes in a header, and a JSON format that includes /// custom attributes.The default format is CSV.The format must match the format of the file stored in the S3 bucket identified in /// the S3Path parameter.For more information, see Adding /// questions and answers. /// /// [System.Management.Automation.Parameter(ValueFromPipelineByPropertyName = true)] [AWSConstantClassSource("Amazon.Kendra.FaqFileFormat")] public Amazon.Kendra.FaqFileFormat FileFormat { get; set; } #endregion #region Parameter IndexId /// /// /// The identifier of the index for the FAQ. /// /// #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 IndexId { get; set; } #endregion #region Parameter S3Path_Key /// /// /// The name of the file. /// /// #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 S3Path_Key { get; set; } #endregion #region Parameter LanguageCode /// /// /// The code for a language. This allows you to support a language for the FAQ document. /// English is supported by default. For more information on supported languages, including /// their codes, see Adding /// documents in languages other than English. /// /// [System.Management.Automation.Parameter(ValueFromPipelineByPropertyName = true)] public System.String LanguageCode { get; set; } #endregion #region Parameter Name /// /// /// A name for the FAQ. /// /// #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 RoleArn /// /// /// The Amazon Resource Name (ARN) of an IAM role with permission to access the S3 bucket /// that contains the FAQs. For more information, see IAM /// access roles for Amazon Kendra. /// /// #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 RoleArn { get; set; } #endregion #region Parameter Tag /// /// /// A list of key-value pairs that identify the FAQ. You can use the tags to identify /// and organize your resources and to control access to resources. /// /// [System.Management.Automation.Parameter(ValueFromPipelineByPropertyName = true)] [Alias("Tags")] public Amazon.Kendra.Model.Tag[] Tag { get; set; } #endregion #region Parameter ClientToken /// /// /// A token that you provide to identify the request to create a FAQ. Multiple calls to /// the CreateFaqRequest API with the same client token will create only /// one FAQ. /// /// [System.Management.Automation.Parameter(ValueFromPipelineByPropertyName = true)] public System.String ClientToken { get; set; } #endregion #region Parameter Select /// /// Use the -Select parameter to control the cmdlet output. The default value is 'Id'. /// Specifying -Select '*' will result in the cmdlet returning the whole service response (Amazon.Kendra.Model.CreateFaqResponse). /// Specifying the name of a property of type Amazon.Kendra.Model.CreateFaqResponse 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; } = "Id"; #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, "New-KNDRFaq (CreateFaq)")) { 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.ClientToken = this.ClientToken; context.Description = this.Description; context.FileFormat = this.FileFormat; context.IndexId = this.IndexId; #if MODULAR if (this.IndexId == null && ParameterWasBound(nameof(this.IndexId))) { WriteWarning("You are passing $null as a value for parameter IndexId 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.LanguageCode = this.LanguageCode; 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.RoleArn = this.RoleArn; #if MODULAR if (this.RoleArn == null && ParameterWasBound(nameof(this.RoleArn))) { WriteWarning("You are passing $null as a value for parameter RoleArn 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.S3Path_Bucket = this.S3Path_Bucket; #if MODULAR if (this.S3Path_Bucket == null && ParameterWasBound(nameof(this.S3Path_Bucket))) { WriteWarning("You are passing $null as a value for parameter S3Path_Bucket 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.S3Path_Key = this.S3Path_Key; #if MODULAR if (this.S3Path_Key == null && ParameterWasBound(nameof(this.S3Path_Key))) { WriteWarning("You are passing $null as a value for parameter S3Path_Key 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.Kendra.Model.CreateFaqRequest(); if (cmdletContext.ClientToken != null) { request.ClientToken = cmdletContext.ClientToken; } if (cmdletContext.Description != null) { request.Description = cmdletContext.Description; } if (cmdletContext.FileFormat != null) { request.FileFormat = cmdletContext.FileFormat; } if (cmdletContext.IndexId != null) { request.IndexId = cmdletContext.IndexId; } if (cmdletContext.LanguageCode != null) { request.LanguageCode = cmdletContext.LanguageCode; } if (cmdletContext.Name != null) { request.Name = cmdletContext.Name; } if (cmdletContext.RoleArn != null) { request.RoleArn = cmdletContext.RoleArn; } // populate S3Path var requestS3PathIsNull = true; request.S3Path = new Amazon.Kendra.Model.S3Path(); System.String requestS3Path_s3Path_Bucket = null; if (cmdletContext.S3Path_Bucket != null) { requestS3Path_s3Path_Bucket = cmdletContext.S3Path_Bucket; } if (requestS3Path_s3Path_Bucket != null) { request.S3Path.Bucket = requestS3Path_s3Path_Bucket; requestS3PathIsNull = false; } System.String requestS3Path_s3Path_Key = null; if (cmdletContext.S3Path_Key != null) { requestS3Path_s3Path_Key = cmdletContext.S3Path_Key; } if (requestS3Path_s3Path_Key != null) { request.S3Path.Key = requestS3Path_s3Path_Key; requestS3PathIsNull = false; } // determine if request.S3Path should be set to null if (requestS3PathIsNull) { request.S3Path = null; } 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.Kendra.Model.CreateFaqResponse CallAWSServiceOperation(IAmazonKendra client, Amazon.Kendra.Model.CreateFaqRequest request) { Utils.Common.WriteVerboseEndpointMessage(this, client.Config, "Amazon Kendra", "CreateFaq"); try { #if DESKTOP return client.CreateFaq(request); #elif CORECLR return client.CreateFaqAsync(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 ClientToken { get; set; } public System.String Description { get; set; } public Amazon.Kendra.FaqFileFormat FileFormat { get; set; } public System.String IndexId { get; set; } public System.String LanguageCode { get; set; } public System.String Name { get; set; } public System.String RoleArn { get; set; } public System.String S3Path_Bucket { get; set; } public System.String S3Path_Key { get; set; } public List Tag { get; set; } public System.Func Select { get; set; } = (response, cmdlet) => response.Id; } } }