Class: Aws::Kendra::Types::UserContext
- Inherits:
-
Struct
- Object
- Struct
- Aws::Kendra::Types::UserContext
- Defined in:
- gems/aws-sdk-kendra/lib/aws-sdk-kendra/types.rb
Overview
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.
Constant Summary collapse
- SENSITIVE =
[]
Instance Attribute Summary collapse
-
#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.
-
#groups ⇒ Array<String>
The list of groups you want to filter search results based on the groups' access to documents.
-
#token ⇒ String
The user context token for filtering search results for a user.
-
#user_id ⇒ String
The identifier of the user you want to filter search results based on their access to documents.
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.
14034 14035 14036 14037 14038 14039 14040 14041 |
# File 'gems/aws-sdk-kendra/lib/aws-sdk-kendra/types.rb', line 14034 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.
14034 14035 14036 14037 14038 14039 14040 14041 |
# File 'gems/aws-sdk-kendra/lib/aws-sdk-kendra/types.rb', line 14034 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.
14034 14035 14036 14037 14038 14039 14040 14041 |
# File 'gems/aws-sdk-kendra/lib/aws-sdk-kendra/types.rb', line 14034 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.
14034 14035 14036 14037 14038 14039 14040 14041 |
# File 'gems/aws-sdk-kendra/lib/aws-sdk-kendra/types.rb', line 14034 class UserContext < Struct.new( :token, :user_id, :groups, :data_source_groups) SENSITIVE = [] include Aws::Structure end |