Struct aws_sdk_kendra::operation::update_access_control_configuration::builders::UpdateAccessControlConfigurationFluentBuilder

pub struct UpdateAccessControlConfigurationFluentBuilder { /* private fields */ }

Fluent builder constructing a request to UpdateAccessControlConfiguration.

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.

Implementations

impl UpdateAccessControlConfigurationFluentBuilder

pub fn as_input(&self) -> &UpdateAccessControlConfigurationInputBuilder

Access the UpdateAccessControlConfiguration as a reference.

pub async fn send( self, ) -> Result<UpdateAccessControlConfigurationOutput, SdkError<UpdateAccessControlConfigurationError, HttpResponse>>

Sends the request and returns the response.

If an error occurs, an SdkError will be returned with additional details that can be matched against.

By default, any retryable failures will be retried twice. Retry behavior is configurable with the RetryConfig, which can be set when configuring the client.

pub fn customize( self, ) -> CustomizableOperation<UpdateAccessControlConfigurationOutput, UpdateAccessControlConfigurationError, Self>

Consumes this builder, creating a customizable operation that can be modified before being sent.

pub fn index_id(self, input: impl Into<String>) -> Self

The identifier of the index for an access control configuration.

pub fn set_index_id(self, input: Option<String>) -> Self

The identifier of the index for an access control configuration.

pub fn get_index_id(&self) -> &Option<String>

The identifier of the index for an access control configuration.

pub fn id(self, input: impl Into<String>) -> Self

The identifier of the access control configuration you want to update.

pub fn set_id(self, input: Option<String>) -> Self

The identifier of the access control configuration you want to update.

pub fn get_id(&self) -> &Option<String>

The identifier of the access control configuration you want to update.

pub fn name(self, input: impl Into<String>) -> Self

A new name for the access control configuration.

pub fn set_name(self, input: Option<String>) -> Self

A new name for the access control configuration.

pub fn get_name(&self) -> &Option<String>

A new name for the access control configuration.

pub fn description(self, input: impl Into<String>) -> Self

A new description for the access control configuration.

pub fn set_description(self, input: Option<String>) -> Self

A new description for the access control configuration.

pub fn get_description(&self) -> &Option<String>

A new description for the access control configuration.

pub fn access_control_list(self, input: Principal) -> Self

Appends an item to AccessControlList.

To override the contents of this collection use set_access_control_list.

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.

pub fn set_access_control_list(self, input: Option<Vec<Principal>>) -> Self

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.

pub fn get_access_control_list(&self) -> &Option<Vec<Principal>>

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.

pub fn hierarchical_access_control_list( self, input: HierarchicalPrincipal, ) -> Self

Appends an item to HierarchicalAccessControlList.

To override the contents of this collection use set_hierarchical_access_control_list.

The updated list of principal lists that define the hierarchy for which documents users should have access to.

pub fn set_hierarchical_access_control_list( self, input: Option<Vec<HierarchicalPrincipal>>, ) -> Self

The updated list of principal lists that define the hierarchy for which documents users should have access to.

pub fn get_hierarchical_access_control_list( &self, ) -> &Option<Vec<HierarchicalPrincipal>>

The updated list of principal lists that define the hierarchy for which documents users should have access to.

Trait Implementations

impl Clone for UpdateAccessControlConfigurationFluentBuilder

fn clone(&self) -> UpdateAccessControlConfigurationFluentBuilder

Returns a copy of the value.

fn clone_from(&mut self, source: &Self)

Performs copy-assignment from source.

impl Debug for UpdateAccessControlConfigurationFluentBuilder

fn fmt(&self, f: &mut Formatter<'_>) -> Result

Formats the value using the given formatter.