Class: Aws::Kendra::Types::UserContext

Inherits:
Struct
  • Object
show all
Defined in:
gems/aws-sdk-kendra/lib/aws-sdk-kendra/types.rb

Overview

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
    },
  ],
}

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.

See Also:

Constant Summary collapse

SENSITIVE = 
[]

Instance Attribute Summary collapse

Instance Attribute Details

#data_source_groups ⇒ Array<Types::DataSourceGroup>

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

Returns:



14259
14260
14261
14262
14263
14264
14265
14266
 
# File 'gems/aws-sdk-kendra/lib/aws-sdk-kendra/types.rb', line 14259

class UserContext < Struct.new(
  :token,
  :user_id,
  :groups,
  :data_source_groups)
  SENSITIVE = []
  include Aws::Structure
end

#groups ⇒ Array<String>

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

Returns:

  • (Array<String>) 


14259
14260
14261
14262
14263
14264
14265
14266
 
# File 'gems/aws-sdk-kendra/lib/aws-sdk-kendra/types.rb', line 14259

class UserContext < Struct.new(
  :token,
  :user_id,
  :groups,
  :data_source_groups)
  SENSITIVE = []
  include Aws::Structure
end

#token ⇒ String

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

Returns:

  • (String) 


14259
14260
14261
14262
14263
14264
14265
14266
 
# File 'gems/aws-sdk-kendra/lib/aws-sdk-kendra/types.rb', line 14259

class UserContext < Struct.new(
  :token,
  :user_id,
  :groups,
  :data_source_groups)
  SENSITIVE = []
  include Aws::Structure
end

#user_id ⇒ String

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

Returns:

  • (String) 


14259
14260
14261
14262
14263
14264
14265
14266
 
# File 'gems/aws-sdk-kendra/lib/aws-sdk-kendra/types.rb', line 14259

class UserContext < Struct.new(
  :token,
  :user_id,
  :groups,
  :data_source_groups)
  SENSITIVE = []
  include Aws::Structure
end