Class: Aws::Kendra::Types::PutPrincipalMappingRequest

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

Overview

Constant Summary collapse

SENSITIVE =
[]

Instance Attribute Summary collapse

Instance Attribute Details

#data_source_idString

The identifier of the data source you want to map users to their groups.

This is useful if a group is tied to multiple data sources, but you only want the group to access documents of a certain data source. For example, the groups “Research”, “Engineering”, and “Sales and Marketing” are all tied to the company’s documents stored in the data sources Confluence and Salesforce. However, “Sales and Marketing” team only needs access to customer-related documents stored in Salesforce.

Returns:

  • (String)


7823
7824
7825
7826
7827
7828
7829
7830
7831
7832
# File 'lib/aws-sdk-kendra/types.rb', line 7823

class PutPrincipalMappingRequest < Struct.new(
  :index_id,
  :data_source_id,
  :group_id,
  :group_members,
  :ordering_id,
  :role_arn)
  SENSITIVE = []
  include Aws::Structure
end

#group_idString

The identifier of the group you want to map its users to.

Returns:

  • (String)


7823
7824
7825
7826
7827
7828
7829
7830
7831
7832
# File 'lib/aws-sdk-kendra/types.rb', line 7823

class PutPrincipalMappingRequest < Struct.new(
  :index_id,
  :data_source_id,
  :group_id,
  :group_members,
  :ordering_id,
  :role_arn)
  SENSITIVE = []
  include Aws::Structure
end

#group_membersTypes::GroupMembers

The list that contains your users or sub groups that belong the same group.

For example, the group “Company” includes the user “CEO” and the sub groups “Research”, “Engineering”, and “Sales and Marketing”.

If you have more than 1000 users and/or sub groups for a single group, you need to provide the path to the S3 file that lists your users and sub groups for a group. Your sub groups can contain more than 1000 users, but the list of sub groups that belong to a group (and/or users) must be no more than 1000.

Returns:



7823
7824
7825
7826
7827
7828
7829
7830
7831
7832
# File 'lib/aws-sdk-kendra/types.rb', line 7823

class PutPrincipalMappingRequest < Struct.new(
  :index_id,
  :data_source_id,
  :group_id,
  :group_members,
  :ordering_id,
  :role_arn)
  SENSITIVE = []
  include Aws::Structure
end

#index_idString

The identifier of the index you want to map users to their groups.

Returns:

  • (String)


7823
7824
7825
7826
7827
7828
7829
7830
7831
7832
# File 'lib/aws-sdk-kendra/types.rb', line 7823

class PutPrincipalMappingRequest < Struct.new(
  :index_id,
  :data_source_id,
  :group_id,
  :group_members,
  :ordering_id,
  :role_arn)
  SENSITIVE = []
  include Aws::Structure
end

#ordering_idInteger

The timestamp identifier you specify to ensure Amazon Kendra does not override the latest ‘PUT` action with previous actions. The highest number ID, which is the ordering ID, is the latest action you want to process and apply on top of other actions with lower number IDs. This prevents previous actions with lower number IDs from possibly overriding the latest action.

The ordering ID can be the Unix time of the last update you made to a group members list. You would then provide this list when calling ‘PutPrincipalMapping`. This ensures your `PUT` action for that updated group with the latest members list doesn’t get overwritten by earlier ‘PUT` actions for the same group which are yet to be processed.

The default ordering ID is the current Unix time in milliseconds that the action was received by Amazon Kendra.

Returns:

  • (Integer)


7823
7824
7825
7826
7827
7828
7829
7830
7831
7832
# File 'lib/aws-sdk-kendra/types.rb', line 7823

class PutPrincipalMappingRequest < Struct.new(
  :index_id,
  :data_source_id,
  :group_id,
  :group_members,
  :ordering_id,
  :role_arn)
  SENSITIVE = []
  include Aws::Structure
end

#role_arnString

The Amazon Resource Name (ARN) of a role that has access to the S3 file that contains your list of users or sub groups that belong to a group.

For more information, see [IAM roles for Amazon Kendra].

[1]: docs.aws.amazon.com/kendra/latest/dg/iam-roles.html#iam-roles-ds

Returns:

  • (String)


7823
7824
7825
7826
7827
7828
7829
7830
7831
7832
# File 'lib/aws-sdk-kendra/types.rb', line 7823

class PutPrincipalMappingRequest < Struct.new(
  :index_id,
  :data_source_id,
  :group_id,
  :group_members,
  :ordering_id,
  :role_arn)
  SENSITIVE = []
  include Aws::Structure
end