Struct UpdateIndexInput 

#[non_exhaustive]
pub struct UpdateIndexInput {
    pub id: Option<String>,
    pub name: Option<String>,
    pub role_arn: Option<String>,
    pub description: Option<String>,
    pub document_metadata_configuration_updates: Option<Vec<DocumentMetadataConfiguration>>,
    pub capacity_units: Option<CapacityUnitsConfiguration>,
    pub user_token_configurations: Option<Vec<UserTokenConfiguration>>,
    pub user_context_policy: Option<UserContextPolicy>,
    pub user_group_resolution_configuration: Option<UserGroupResolutionConfiguration>,
}

Fields (Non-exhaustive)

Non-exhaustive structs could have additional fields added in future. Therefore, non-exhaustive structs cannot be constructed in external crates using the traditional Struct { .. } syntax; cannot be matched against without a wildcard ..; and struct update syntax will not work.

id: Option<String>

The identifier of the index you want to update.

name: Option<String>

A new name for the index.

role_arn: Option<String>

An Identity and Access Management (IAM) role that gives Amazon Kendra permission to access Amazon CloudWatch logs and metrics.

description: Option<String>

A new description for the index.

document_metadata_configuration_updates: Option<Vec<DocumentMetadataConfiguration>>

The document metadata configuration you want to update for the index. Document metadata are fields or attributes associated with your documents. For example, the company department name associated with each document.

capacity_units: Option<CapacityUnitsConfiguration>

Sets the number of additional document storage and query capacity units that should be used by the index. You can change the capacity of the index up to 5 times per day, or make 5 API calls.

If you are using extra storage units, you can't reduce the storage capacity below what is required to meet the storage needs for your index.

user_token_configurations: Option<Vec<UserTokenConfiguration>>

The user token configuration.

If you're using an Amazon Kendra Gen AI Enterprise Edition index and you try to use UserTokenConfigurations to configure user context policy, Amazon Kendra returns a ValidationException error.

user_context_policy: Option<UserContextPolicy>

The user context policy.

If you're using an Amazon Kendra Gen AI Enterprise Edition index, you can only use ATTRIBUTE_FILTER to filter search results by user context. If you're using an Amazon Kendra Gen AI Enterprise Edition index and you try to use USER_TOKEN to configure user context policy, Amazon Kendra returns a ValidationException error.

user_group_resolution_configuration: Option<UserGroupResolutionConfiguration>

Gets users and groups from IAM Identity Center identity source. To configure this, see UserGroupResolutionConfiguration. This is useful for user context filtering, where search results are filtered based on the user or their group access to documents.

If you're using an Amazon Kendra Gen AI Enterprise Edition index, UserGroupResolutionConfiguration isn't supported.

Implementations

impl UpdateIndexInput

pub fn id(&self) -> Option<&str>

The identifier of the index you want to update.

pub fn name(&self) -> Option<&str>

A new name for the index.

pub fn role_arn(&self) -> Option<&str>

An Identity and Access Management (IAM) role that gives Amazon Kendra permission to access Amazon CloudWatch logs and metrics.

pub fn description(&self) -> Option<&str>

A new description for the index.

pub fn document_metadata_configuration_updates( &self, ) -> &[DocumentMetadataConfiguration]

The document metadata configuration you want to update for the index. Document metadata are fields or attributes associated with your documents. For example, the company department name associated with each document.

If no value was sent for this field, a default will be set. If you want to determine if no value was sent, use .document_metadata_configuration_updates.is_none().

pub fn capacity_units(&self) -> Option<&CapacityUnitsConfiguration>

Sets the number of additional document storage and query capacity units that should be used by the index. You can change the capacity of the index up to 5 times per day, or make 5 API calls.

If you are using extra storage units, you can't reduce the storage capacity below what is required to meet the storage needs for your index.

pub fn user_token_configurations(&self) -> &[UserTokenConfiguration]

The user token configuration.

If you're using an Amazon Kendra Gen AI Enterprise Edition index and you try to use UserTokenConfigurations to configure user context policy, Amazon Kendra returns a ValidationException error.

If no value was sent for this field, a default will be set. If you want to determine if no value was sent, use .user_token_configurations.is_none().

pub fn user_context_policy(&self) -> Option<&UserContextPolicy>

The user context policy.

If you're using an Amazon Kendra Gen AI Enterprise Edition index, you can only use ATTRIBUTE_FILTER to filter search results by user context. If you're using an Amazon Kendra Gen AI Enterprise Edition index and you try to use USER_TOKEN to configure user context policy, Amazon Kendra returns a ValidationException error.

pub fn user_group_resolution_configuration( &self, ) -> Option<&UserGroupResolutionConfiguration>

Gets users and groups from IAM Identity Center identity source. To configure this, see UserGroupResolutionConfiguration. This is useful for user context filtering, where search results are filtered based on the user or their group access to documents.

If you're using an Amazon Kendra Gen AI Enterprise Edition index, UserGroupResolutionConfiguration isn't supported.

impl UpdateIndexInput

pub fn builder() -> UpdateIndexInputBuilder

Creates a new builder-style object to manufacture UpdateIndexInput.

Trait Implementations

impl Clone for UpdateIndexInput

fn clone(&self) -> UpdateIndexInput

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for UpdateIndexInput

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

Formats the value using the given formatter.

impl PartialEq for UpdateIndexInput

fn eq(&self, other: &UpdateIndexInput) -> bool

Tests for self and other values to be equal, and is used by ==.

fn ne(&self, other: &Rhs) -> bool

Tests for !=. The default implementation is almost always sufficient, and should not be overridden without very good reason.

impl StructuralPartialEq for UpdateIndexInput