class Aws::Kendra::Types::UserContext

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

This is used for filtering search results for different users based on their access to documents.

You provide one of the following:

If you provide both, an exception is thrown.

@note When making an API call, you may pass UserContext

data as a hash:

    {
      token: "Token",
      user_id: "PrincipalName",
      groups: ["PrincipalName"],
      data_source_groups: [
        {
          group_id: "PrincipalName", # required
          data_source_id: "DataSourceId", # required
        },
      ],
    }

@!attribute [rw] token

The user context token for filtering search results for a user. It
must be a JWT or a JSON token.
@return [String]

@!attribute [rw] user_id

The identifier of the user you want to filter search results based
on their access to documents.
@return [String]

@!attribute [rw] groups

The list of groups you want to filter search results based on the
groups' access to documents.
@return [Array<String>]

@!attribute [rw] data_source_groups

The list of data source groups you want to filter search results
based on groups' access to documents in that data source.
@return [Array<Types::DataSourceGroup>]

@see docs.aws.amazon.com/goto/WebAPI/kendra-2019-02-03/UserContext AWS API Documentation

Constants

SENSITIVE