class Aws::Kendra::Types::PutPrincipalMappingRequest

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

data as a hash:

    {
      index_id: "IndexId", # required
      data_source_id: "DataSourceId",
      group_id: "GroupId", # required
      group_members: { # required
        member_groups: [
          {
            group_id: "GroupId", # required
            data_source_id: "DataSourceId",
          },
        ],
        member_users: [
          {
            user_id: "UserId", # required
          },
        ],
        s3_pathfor_group_members: {
          bucket: "S3BucketName", # required
          key: "S3ObjectKey", # required
        },
      },
      ordering_id: 1,
      role_arn: "RoleArn",
    }

@!attribute [rw] index_id

The identifier of the index you want to map users to their groups.
@return [String]

@!attribute [rw] data_source_id

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.
@return [String]

@!attribute [rw] group_id

The identifier of the group you want to map its users to.
@return [String]

@!attribute [rw] group_members

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.
@return [Types::GroupMembers]

@!attribute [rw] ordering_id

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.
@return [Integer]

@!attribute [rw] role_arn

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].

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

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

Constants

SENSITIVE