/******************************************************************************* * 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 { /// /// Removes one or more documents from an index. The documents must have been added with /// the BatchPutDocument API. /// /// /// /// The documents are deleted asynchronously. You can see the progress of the deletion /// by using Amazon Web Services CloudWatch. Any error messages related to the processing /// of the batch are sent to you CloudWatch log. /// /// [Cmdlet("Remove", "KNDRDocumentBatch", SupportsShouldProcess = true, ConfirmImpact = ConfirmImpact.High)] [OutputType("Amazon.Kendra.Model.BatchDeleteDocumentResponseFailedDocument")] [AWSCmdlet("Calls the Amazon Kendra BatchDeleteDocument API operation.", Operation = new[] {"BatchDeleteDocument"}, SelectReturnType = typeof(Amazon.Kendra.Model.BatchDeleteDocumentResponse))] [AWSCmdletOutput("Amazon.Kendra.Model.BatchDeleteDocumentResponseFailedDocument or Amazon.Kendra.Model.BatchDeleteDocumentResponse", "This cmdlet returns a collection of Amazon.Kendra.Model.BatchDeleteDocumentResponseFailedDocument objects.", "The service call response (type Amazon.Kendra.Model.BatchDeleteDocumentResponse) can also be referenced from properties attached to the cmdlet entry in the $AWSHistory stack." )] public partial class RemoveKNDRDocumentBatchCmdlet : AmazonKendraClientCmdlet, IExecutor { #region Parameter DataSourceSyncJobMetricTarget_DataSourceId /// /// /// The ID of the data source that is running the sync job. /// /// [System.Management.Automation.Parameter(ValueFromPipelineByPropertyName = true)] public System.String DataSourceSyncJobMetricTarget_DataSourceId { get; set; } #endregion #region Parameter DataSourceSyncJobMetricTarget_DataSourceSyncJobId /// /// /// The ID of the sync job that is running on the data source.If the ID of a sync job is not provided and there is a sync job running, then the /// ID of this sync job is used and metrics are generated for this sync job.If the ID of a sync job is not provided and there is no sync job running, then no /// metrics are generated and documents are indexed/deleted at the index level without /// sync job metrics included. /// /// [System.Management.Automation.Parameter(ValueFromPipelineByPropertyName = true)] public System.String DataSourceSyncJobMetricTarget_DataSourceSyncJobId { get; set; } #endregion #region Parameter DocumentIdList /// /// /// One or more identifiers for documents to delete from the index. /// /// #if !MODULAR [System.Management.Automation.Parameter(ValueFromPipelineByPropertyName = true)] #else [System.Management.Automation.Parameter(ValueFromPipelineByPropertyName = true, Mandatory = true)] [System.Management.Automation.AllowEmptyCollection] [System.Management.Automation.AllowNull] #endif [Amazon.PowerShell.Common.AWSRequiredParameter] public System.String[] DocumentIdList { get; set; } #endregion #region Parameter IndexId /// /// /// The identifier of the index that contains the documents to delete. /// /// #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 IndexId { get; set; } #endregion #region Parameter Select /// /// Use the -Select parameter to control the cmdlet output. The default value is 'FailedDocuments'. /// Specifying -Select '*' will result in the cmdlet returning the whole service response (Amazon.Kendra.Model.BatchDeleteDocumentResponse). /// Specifying the name of a property of type Amazon.Kendra.Model.BatchDeleteDocumentResponse 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; } = "FailedDocuments"; #endregion #region Parameter PassThru /// /// Changes the cmdlet behavior to return the value passed to the IndexId parameter. /// The -PassThru parameter is deprecated, use -Select '^IndexId' instead. This parameter will be removed in a future version. /// [System.Obsolete("The -PassThru parameter is deprecated, use -Select '^IndexId' 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.IndexId), MyInvocation.BoundParameters); if (!ConfirmShouldProceed(this.Force.IsPresent, resourceIdentifiersText, "Remove-KNDRDocumentBatch (BatchDeleteDocument)")) { 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.IndexId; } #pragma warning restore CS0618, CS0612 //A class member was marked with the Obsolete attribute context.DataSourceSyncJobMetricTarget_DataSourceId = this.DataSourceSyncJobMetricTarget_DataSourceId; context.DataSourceSyncJobMetricTarget_DataSourceSyncJobId = this.DataSourceSyncJobMetricTarget_DataSourceSyncJobId; if (this.DocumentIdList != null) { context.DocumentIdList = new List(this.DocumentIdList); } #if MODULAR if (this.DocumentIdList == null && ParameterWasBound(nameof(this.DocumentIdList))) { WriteWarning("You are passing $null as a value for parameter DocumentIdList 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.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 // 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.BatchDeleteDocumentRequest(); // populate DataSourceSyncJobMetricTarget var requestDataSourceSyncJobMetricTargetIsNull = true; request.DataSourceSyncJobMetricTarget = new Amazon.Kendra.Model.DataSourceSyncJobMetricTarget(); System.String requestDataSourceSyncJobMetricTarget_dataSourceSyncJobMetricTarget_DataSourceId = null; if (cmdletContext.DataSourceSyncJobMetricTarget_DataSourceId != null) { requestDataSourceSyncJobMetricTarget_dataSourceSyncJobMetricTarget_DataSourceId = cmdletContext.DataSourceSyncJobMetricTarget_DataSourceId; } if (requestDataSourceSyncJobMetricTarget_dataSourceSyncJobMetricTarget_DataSourceId != null) { request.DataSourceSyncJobMetricTarget.DataSourceId = requestDataSourceSyncJobMetricTarget_dataSourceSyncJobMetricTarget_DataSourceId; requestDataSourceSyncJobMetricTargetIsNull = false; } System.String requestDataSourceSyncJobMetricTarget_dataSourceSyncJobMetricTarget_DataSourceSyncJobId = null; if (cmdletContext.DataSourceSyncJobMetricTarget_DataSourceSyncJobId != null) { requestDataSourceSyncJobMetricTarget_dataSourceSyncJobMetricTarget_DataSourceSyncJobId = cmdletContext.DataSourceSyncJobMetricTarget_DataSourceSyncJobId; } if (requestDataSourceSyncJobMetricTarget_dataSourceSyncJobMetricTarget_DataSourceSyncJobId != null) { request.DataSourceSyncJobMetricTarget.DataSourceSyncJobId = requestDataSourceSyncJobMetricTarget_dataSourceSyncJobMetricTarget_DataSourceSyncJobId; requestDataSourceSyncJobMetricTargetIsNull = false; } // determine if request.DataSourceSyncJobMetricTarget should be set to null if (requestDataSourceSyncJobMetricTargetIsNull) { request.DataSourceSyncJobMetricTarget = null; } if (cmdletContext.DocumentIdList != null) { request.DocumentIdList = cmdletContext.DocumentIdList; } if (cmdletContext.IndexId != null) { request.IndexId = cmdletContext.IndexId; } 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.BatchDeleteDocumentResponse CallAWSServiceOperation(IAmazonKendra client, Amazon.Kendra.Model.BatchDeleteDocumentRequest request) { Utils.Common.WriteVerboseEndpointMessage(this, client.Config, "Amazon Kendra", "BatchDeleteDocument"); try { #if DESKTOP return client.BatchDeleteDocument(request); #elif CORECLR return client.BatchDeleteDocumentAsync(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 DataSourceSyncJobMetricTarget_DataSourceId { get; set; } public System.String DataSourceSyncJobMetricTarget_DataSourceSyncJobId { get; set; } public List DocumentIdList { get; set; } public System.String IndexId { get; set; } public System.Func Select { get; set; } = (response, cmdlet) => response.FailedDocuments; } } }