/*******************************************************************************
* 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
{
///
/// Deletes a group so that all users and sub groups that belong to the group can no longer
/// access documents only available to that group.
///
///
///
/// For example, after deleting the group "Summer Interns", all interns who belonged to
/// that group no longer see intern-only documents in their search results.
///
/// If you want to delete or replace users or sub groups of a group, you need to use the
/// PutPrincipalMapping
operation. For example, if a user in the group "Engineering"
/// leaves the engineering team and another user takes their place, you provide an updated
/// list of users or sub groups that belong to the "Engineering" group when calling PutPrincipalMapping
.
/// You can update your internal list of users or sub groups and input this list when
/// calling PutPrincipalMapping
.
/// DeletePrincipalMapping
is currently not supported in the Amazon Web
/// Services GovCloud (US-West) region.
///
///
[Cmdlet("Remove", "KNDRPrincipalMapping", SupportsShouldProcess = true, ConfirmImpact = ConfirmImpact.High)]
[OutputType("None")]
[AWSCmdlet("Calls the Amazon Kendra DeletePrincipalMapping API operation.", Operation = new[] {"DeletePrincipalMapping"}, SelectReturnType = typeof(Amazon.Kendra.Model.DeletePrincipalMappingResponse))]
[AWSCmdletOutput("None or Amazon.Kendra.Model.DeletePrincipalMappingResponse",
"This cmdlet does not generate any output." +
"The service response (type Amazon.Kendra.Model.DeletePrincipalMappingResponse) can be referenced from properties attached to the cmdlet entry in the $AWSHistory stack."
)]
public partial class RemoveKNDRPrincipalMappingCmdlet : AmazonKendraClientCmdlet, IExecutor
{
#region Parameter DataSourceId
///
///
/// The identifier of the data source you want to delete a group from.A group can be tied to multiple data sources. You can delete a group from accessing
/// documents in a certain data source. For example, the groups "Research", "Engineering",
/// and "Sales and Marketing" are all tied to the company's documents stored in the data
/// sources Confluence and Salesforce. You want to delete "Research" and "Engineering"
/// groups from Salesforce, so that these groups cannot access customer-related documents
/// stored in Salesforce. Only "Sales and Marketing" should access documents in the Salesforce
/// data source.
///
///
[System.Management.Automation.Parameter(ValueFromPipelineByPropertyName = true)]
public System.String DataSourceId { get; set; }
#endregion
#region Parameter GroupId
///
///
/// The identifier of the group you want 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 GroupId { get; set; }
#endregion
#region Parameter IndexId
///
///
/// The identifier of the index you want to delete a group from.
///
///
#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 OrderingId
///
///
/// The timestamp identifier you specify to ensure Amazon Kendra does not override the
/// latest DELETE
action with previous actions. The highest number ID, which
/// is the ordering ID, is the latest action you want to process and apply on top of other
/// actions with lower number IDs. This prevents previous actions with lower number IDs
/// from possibly overriding the latest action.The ordering ID can be the Unix time of the last update you made to a group members
/// list. You would then provide this list when calling PutPrincipalMapping
.
/// This ensures your DELETE
action for that updated group with the latest
/// members list doesn't get overwritten by earlier DELETE
actions for the
/// same group which are yet to be processed.The default ordering ID is the current Unix time in milliseconds that the action was
/// received by Amazon Kendra.
///
///
[System.Management.Automation.Parameter(ValueFromPipelineByPropertyName = true)]
public System.Int64? OrderingId { 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.Kendra.Model.DeletePrincipalMappingResponse).
/// 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 GroupId parameter.
/// The -PassThru parameter is deprecated, use -Select '^GroupId' instead. This parameter will be removed in a future version.
///
[System.Obsolete("The -PassThru parameter is deprecated, use -Select '^GroupId' 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-KNDRPrincipalMapping (DeletePrincipalMapping)"))
{
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.GroupId;
}
#pragma warning restore CS0618, CS0612 //A class member was marked with the Obsolete attribute
context.DataSourceId = this.DataSourceId;
context.GroupId = this.GroupId;
#if MODULAR
if (this.GroupId == null && ParameterWasBound(nameof(this.GroupId)))
{
WriteWarning("You are passing $null as a value for parameter GroupId 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
context.OrderingId = this.OrderingId;
// 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.DeletePrincipalMappingRequest();
if (cmdletContext.DataSourceId != null)
{
request.DataSourceId = cmdletContext.DataSourceId;
}
if (cmdletContext.GroupId != null)
{
request.GroupId = cmdletContext.GroupId;
}
if (cmdletContext.IndexId != null)
{
request.IndexId = cmdletContext.IndexId;
}
if (cmdletContext.OrderingId != null)
{
request.OrderingId = cmdletContext.OrderingId.Value;
}
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.DeletePrincipalMappingResponse CallAWSServiceOperation(IAmazonKendra client, Amazon.Kendra.Model.DeletePrincipalMappingRequest request)
{
Utils.Common.WriteVerboseEndpointMessage(this, client.Config, "Amazon Kendra", "DeletePrincipalMapping");
try
{
#if DESKTOP
return client.DeletePrincipalMapping(request);
#elif CORECLR
return client.DeletePrincipalMappingAsync(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 DataSourceId { get; set; }
public System.String GroupId { get; set; }
public System.String IndexId { get; set; }
public System.Int64? OrderingId { get; set; }
public System.Func Select { get; set; } =
(response, cmdlet) => null;
}
}
}