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.

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

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

Instance Attribute Details

#data_source_groupsArray<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:



9106
9107
9108
9109
9110
9111
9112
9113
# File 'gems/aws-sdk-kendra/lib/aws-sdk-kendra/types.rb', line 9106

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

#groupsArray<String>

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

Returns:

  • (Array<String>)


9106
9107
9108
9109
9110
9111
9112
9113
# File 'gems/aws-sdk-kendra/lib/aws-sdk-kendra/types.rb', line 9106

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

#tokenString

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

Returns:

  • (String)


9106
9107
9108
9109
9110
9111
9112
9113
# File 'gems/aws-sdk-kendra/lib/aws-sdk-kendra/types.rb', line 9106

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

#user_idString

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

Returns:

  • (String)


9106
9107
9108
9109
9110
9111
9112
9113
# File 'gems/aws-sdk-kendra/lib/aws-sdk-kendra/types.rb', line 9106

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