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

Inherits:
Struct
  • Object
show all
Defined in:
gems/aws-sdk-qbusiness/lib/aws-sdk-qbusiness/types.rb

Overview

See Also:

Constant Summary collapse

SENSITIVE = 
[]

Instance Attribute Summary collapse

Instance Attribute Details

#application_id ⇒ String

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

Returns:

  • (String) 


6514
6515
6516
6517
6518
6519
6520
6521
6522
6523
6524
 
# File 'gems/aws-sdk-qbusiness/lib/aws-sdk-qbusiness/types.rb', line 6514

class PutGroupRequest < Struct.new(
  :application_id,
  :index_id,
  :group_name,
  :data_source_id,
  :type,
  :group_members,
  :role_arn)
  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) 


6514
6515
6516
6517
6518
6519
6520
6521
6522
6523
6524
 
# File 'gems/aws-sdk-qbusiness/lib/aws-sdk-qbusiness/types.rb', line 6514

class PutGroupRequest < Struct.new(
  :application_id,
  :index_id,
  :group_name,
  :data_source_id,
  :type,
  :group_members,
  :role_arn)
  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:



6514
6515
6516
6517
6518
6519
6520
6521
6522
6523
6524
 
# File 'gems/aws-sdk-qbusiness/lib/aws-sdk-qbusiness/types.rb', line 6514

class PutGroupRequest < Struct.new(
  :application_id,
  :index_id,
  :group_name,
  :data_source_id,
  :type,
  :group_members,
  :role_arn)
  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".

Returns:

  • (String) 


6514
6515
6516
6517
6518
6519
6520
6521
6522
6523
6524
 
# File 'gems/aws-sdk-qbusiness/lib/aws-sdk-qbusiness/types.rb', line 6514

class PutGroupRequest < Struct.new(
  :application_id,
  :index_id,
  :group_name,
  :data_source_id,
  :type,
  :group_members,
  :role_arn)
  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) 


6514
6515
6516
6517
6518
6519
6520
6521
6522
6523
6524
 
# File 'gems/aws-sdk-qbusiness/lib/aws-sdk-qbusiness/types.rb', line 6514

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

#role_arn ⇒ String

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

Returns:

  • (String) 


6514
6515
6516
6517
6518
6519
6520
6521
6522
6523
6524
 
# File 'gems/aws-sdk-qbusiness/lib/aws-sdk-qbusiness/types.rb', line 6514

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

#type ⇒ String

The type of the group.

Returns:

  • (String) 


6514
6515
6516
6517
6518
6519
6520
6521
6522
6523
6524
 
# File 'gems/aws-sdk-qbusiness/lib/aws-sdk-qbusiness/types.rb', line 6514

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