Class: Aws::QBusiness::Types::PutGroupRequest

Inherits:

Struct

• Object
• Struct
• Aws::QBusiness::Types::PutGroupRequest

Defined in:

gems/aws-sdk-qbusiness/lib/aws-sdk-qbusiness/types.rb

Overview

See Also:

• AWS API Documentation

Constant Summary

SENSITIVE =

[]

Instance Attribute Summary

• #application_id ⇒ String

  The identifier of the application in which the user and group mapping belongs.

• #data_source_id ⇒ String

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

• #group_members ⇒ Types::GroupMembers

  A list of users or sub groups that belong to a group.

• #group_name ⇒ String

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

• #index_id ⇒ String

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

• #type ⇒ String

  The type of the group.

Instance Attribute Details

#application_id ⇒ String

The identifier of the application in which the user and group mapping belongs.

Returns:

• (String)

# File 'gems/aws-sdk-qbusiness/lib/aws-sdk-qbusiness/types.rb', line 4976

class PutGroupRequest < Struct.new(
  :application_id,
  :index_id,
  :group_name,
  :data_source_id,
  :type,
  :group_members)
  SENSITIVE = []
  include Aws::Structure
end

#data_source_id ⇒ String

The identifier of the data source for which 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)

# File 'gems/aws-sdk-qbusiness/lib/aws-sdk-qbusiness/types.rb', line 4976

class PutGroupRequest < Struct.new(
  :application_id,
  :index_id,
  :group_name,
  :data_source_id,
  :type,
  :group_members)
  SENSITIVE = []
  include Aws::Structure
end

#group_members ⇒ Types::GroupMembers

A list of users or sub groups that belong to a group. This is for generating Amazon Q Business chat results only from document a user has access to.

Returns:

• (Types::GroupMembers)

# File 'gems/aws-sdk-qbusiness/lib/aws-sdk-qbusiness/types.rb', line 4976

class PutGroupRequest < Struct.new(
  :application_id,
  :index_id,
  :group_name,
  :data_source_id,
  :type,
  :group_members)
  SENSITIVE = []
  include Aws::Structure
end

#group_name ⇒ String

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:

• (String)

# File 'gems/aws-sdk-qbusiness/lib/aws-sdk-qbusiness/types.rb', line 4976

class PutGroupRequest < Struct.new(
  :application_id,
  :index_id,
  :group_name,
  :data_source_id,
  :type,
  :group_members)
  SENSITIVE = []
  include Aws::Structure
end

#index_id ⇒ String

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

Returns:

• (String)

# File 'gems/aws-sdk-qbusiness/lib/aws-sdk-qbusiness/types.rb', line 4976

class PutGroupRequest < Struct.new(
  :application_id,
  :index_id,
  :group_name,
  :data_source_id,
  :type,
  :group_members)
  SENSITIVE = []
  include Aws::Structure
end

#type ⇒ String

The type of the group.

Returns:

• (String)

# File 'gems/aws-sdk-qbusiness/lib/aws-sdk-qbusiness/types.rb', line 4976

class PutGroupRequest < Struct.new(
  :application_id,
  :index_id,
  :group_name,
  :data_source_id,
  :type,
  :group_members)
  SENSITIVE = []
  include Aws::Structure
end