kendra/aws.sdk.kotlin.services.kendra.model/UserContext

UserContext

Provides information about the user context for an Amazon Kendra index.

User context filtering is a kind of personalized search with the benefit of controlling access to documents. For example, not all teams that search the company portal for information should access top-secret company documents, nor are these documents relevant to all users. Only specific users or groups of teams given access to top-secret documents should see these documents in their search results.

You provide one of the following:

User token
User ID, the groups the user belongs to, and any data sources the groups can access.

If you provide both, an exception is thrown.

Types

Builder

class Builder

Companion

object Companion

Properties

dataSourceGroups

val dataSourceGroups: List<DataSourceGroup>?

The list of data source groups you want to filter search results based on groups' access to documents in that data source.

groups

val groups: List<String>?

The list of groups you want to filter search results based on the groups' access to documents.

token

val token: String?

The user context token for filtering search results for a user. It must be a JWT or a JSON token.

userId

val userId: String?

The identifier of the user you want to filter search results based on their access to documents.

Functions

copy

inline fun copy(block: UserContext.Builder.() -> Unit = {}): UserContext

equals

open operator override fun equals(other: Any?): Boolean

hashCode

open override fun hashCode(): Int

toString

open override fun toString(): String