/*******************************************************************************
* 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
{
///
/// Updates an access control configuration for your documents in an index. This includes
/// user and group access information for your documents. This is useful for user context
/// filtering, where search results are filtered based on the user or their group access
/// to documents.
///
///
///
/// You can update an access control configuration you created without indexing all of
/// your documents again. For example, your index contains top-secret company documents
/// that only certain employees or users should access. You created an 'allow' access
/// control configuration for one user who recently joined the 'top-secret' team, switching
/// from a team with 'deny' access to top-secret documents. However, the user suddenly
/// returns to their previous team and should no longer have access to top secret documents.
/// You can update the access control configuration to re-configure access control for
/// your documents as circumstances change.
///
/// You call the BatchPutDocument
/// API to apply the updated access control configuration, with the AccessControlConfigurationId
/// included in the Document
/// object. If you use an S3 bucket as a data source, you synchronize your data source
/// to apply the AccessControlConfigurationId
in the .metadata.json
/// file. Amazon Kendra currently only supports access control configuration for S3 data
/// sources and documents indexed using the BatchPutDocument
API.
///
///
[Cmdlet("Update", "KNDRAccessControlConfiguration", SupportsShouldProcess = true, ConfirmImpact = ConfirmImpact.Medium)]
[OutputType("None")]
[AWSCmdlet("Calls the Amazon Kendra UpdateAccessControlConfiguration API operation.", Operation = new[] {"UpdateAccessControlConfiguration"}, SelectReturnType = typeof(Amazon.Kendra.Model.UpdateAccessControlConfigurationResponse))]
[AWSCmdletOutput("None or Amazon.Kendra.Model.UpdateAccessControlConfigurationResponse",
"This cmdlet does not generate any output." +
"The service response (type Amazon.Kendra.Model.UpdateAccessControlConfigurationResponse) can be referenced from properties attached to the cmdlet entry in the $AWSHistory stack."
)]
public partial class UpdateKNDRAccessControlConfigurationCmdlet : AmazonKendraClientCmdlet, IExecutor
{
#region Parameter AccessControlList
///
///
/// Information you want to update on principals (users and/or groups) and which documents
/// they should have access to. This is useful for user context filtering, where search
/// results are filtered based on the user or their group access to documents.
///
///
[System.Management.Automation.Parameter(ValueFromPipelineByPropertyName = true)]
public Amazon.Kendra.Model.Principal[] AccessControlList { get; set; }
#endregion
#region Parameter Description
///
///
/// A new description for the access control configuration.
///
///
[System.Management.Automation.Parameter(ValueFromPipelineByPropertyName = true)]
public System.String Description { get; set; }
#endregion
#region Parameter HierarchicalAccessControlList
///
///
/// The updated list of principal
/// lists that define the hierarchy for which documents users should have access to.
///
///
[System.Management.Automation.Parameter(ValueFromPipelineByPropertyName = true)]
public Amazon.Kendra.Model.HierarchicalPrincipal[] HierarchicalAccessControlList { get; set; }
#endregion
#region Parameter Id
///
///
/// The identifier of the access control configuration you want to update.
///
///
#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 Id { get; set; }
#endregion
#region Parameter IndexId
///
///
/// The identifier of the index for an access control configuration.
///
///
#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 Name
///
///
/// A new name for the access control configuration.
///
///
[System.Management.Automation.Parameter(ValueFromPipelineByPropertyName = true)]
public System.String Name { 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.UpdateAccessControlConfigurationResponse).
/// 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 Id parameter.
/// The -PassThru parameter is deprecated, use -Select '^Id' instead. This parameter will be removed in a future version.
///
[System.Obsolete("The -PassThru parameter is deprecated, use -Select '^Id' 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.Id), MyInvocation.BoundParameters);
if (!ConfirmShouldProceed(this.Force.IsPresent, resourceIdentifiersText, "Update-KNDRAccessControlConfiguration (UpdateAccessControlConfiguration)"))
{
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.Id;
}
#pragma warning restore CS0618, CS0612 //A class member was marked with the Obsolete attribute
if (this.AccessControlList != null)
{
context.AccessControlList = new List(this.AccessControlList);
}
context.Description = this.Description;
if (this.HierarchicalAccessControlList != null)
{
context.HierarchicalAccessControlList = new List(this.HierarchicalAccessControlList);
}
context.Id = this.Id;
#if MODULAR
if (this.Id == null && ParameterWasBound(nameof(this.Id)))
{
WriteWarning("You are passing $null as a value for parameter Id 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.Name = this.Name;
// 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.UpdateAccessControlConfigurationRequest();
if (cmdletContext.AccessControlList != null)
{
request.AccessControlList = cmdletContext.AccessControlList;
}
if (cmdletContext.Description != null)
{
request.Description = cmdletContext.Description;
}
if (cmdletContext.HierarchicalAccessControlList != null)
{
request.HierarchicalAccessControlList = cmdletContext.HierarchicalAccessControlList;
}
if (cmdletContext.Id != null)
{
request.Id = cmdletContext.Id;
}
if (cmdletContext.IndexId != null)
{
request.IndexId = cmdletContext.IndexId;
}
if (cmdletContext.Name != null)
{
request.Name = cmdletContext.Name;
}
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.UpdateAccessControlConfigurationResponse CallAWSServiceOperation(IAmazonKendra client, Amazon.Kendra.Model.UpdateAccessControlConfigurationRequest request)
{
Utils.Common.WriteVerboseEndpointMessage(this, client.Config, "Amazon Kendra", "UpdateAccessControlConfiguration");
try
{
#if DESKTOP
return client.UpdateAccessControlConfiguration(request);
#elif CORECLR
return client.UpdateAccessControlConfigurationAsync(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 List AccessControlList { get; set; }
public System.String Description { get; set; }
public List HierarchicalAccessControlList { get; set; }
public System.String Id { get; set; }
public System.String IndexId { get; set; }
public System.String Name { get; set; }
public System.Func Select { get; set; } =
(response, cmdlet) => null;
}
}
}