Update Index

kendra_update_index

R Documentation

Updates an Amazon Kendra index

Description

Updates an Amazon Kendra index.

Usage

kendra_update_index(Id, Name, RoleArn, Description,
  DocumentMetadataConfigurationUpdates, CapacityUnits,
  UserTokenConfigurations, UserContextPolicy,
  UserGroupResolutionConfiguration)

Arguments

Id

[required] The identifier of the index you want to update.

Name

A new name for the index.

RoleArn

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

Description

A new description for the index.

DocumentMetadataConfigurationUpdates

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.

CapacityUnits

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.

UserTokenConfigurations

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.

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.

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.

Value

An empty list.

Request syntax

svc$update_index(
  Id = "string",
  Name = "string",
  RoleArn = "string",
  Description = "string",
  DocumentMetadataConfigurationUpdates = list(
    list(
      Name = "string",
      Type = "STRING_VALUE"|"STRING_LIST_VALUE"|"LONG_VALUE"|"DATE_VALUE",
      Relevance = list(
        Freshness = TRUE|FALSE,
        Importance = 123,
        Duration = "string",
        RankOrder = "ASCENDING"|"DESCENDING",
        ValueImportanceMap = list(
          123
        )
      ),
      Search = list(
        Facetable = TRUE|FALSE,
        Searchable = TRUE|FALSE,
        Displayable = TRUE|FALSE,
        Sortable = TRUE|FALSE
      )
    )
  ),
  CapacityUnits = list(
    StorageCapacityUnits = 123,
    QueryCapacityUnits = 123
  ),
  UserTokenConfigurations = list(
    list(
      JwtTokenTypeConfiguration = list(
        KeyLocation = "URL"|"SECRET_MANAGER",
        URL = "string",
        SecretManagerArn = "string",
        UserNameAttributeField = "string",
        GroupAttributeField = "string",
        Issuer = "string",
        ClaimRegex = "string"
      ),
      JsonTokenTypeConfiguration = list(
        UserNameAttributeField = "string",
        GroupAttributeField = "string"
      )
    )
  ),
  UserContextPolicy = "ATTRIBUTE_FILTER"|"USER_TOKEN",
  UserGroupResolutionConfiguration = list(
    UserGroupResolutionMode = "AWS_SSO"|"NONE"
  )
)