Class: Aws::QBusiness::Types::DeleteGroupRequest

Inherits:
Struct
  • Object
show all
Includes:
Structure
Defined in:
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 group mapping belongs.

Returns:

  • (String) 


2742
2743
2744
2745
2746
2747
2748
2749
 
# File 'lib/aws-sdk-qbusiness/types.rb', line 2742

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

#data_source_id ⇒ String

The identifier of the data source linked to the group

A group can be tied to multiple data sources. You can delete a group from accessing documents in 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. You want to delete “Research” and “Engineering” groups from Salesforce, so that these groups cannot access customer-related documents stored in Salesforce. Only “Sales and Marketing” should access documents in the Salesforce data source.

Returns:

  • (String) 


2742
2743
2744
2745
2746
2747
2748
2749
 
# File 'lib/aws-sdk-qbusiness/types.rb', line 2742

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

#group_name ⇒ String

The name of the group you want to delete.

Returns:

  • (String) 


2742
2743
2744
2745
2746
2747
2748
2749
 
# File 'lib/aws-sdk-qbusiness/types.rb', line 2742

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

#index_id ⇒ String

The identifier of the index you want to delete the group from.

Returns:

  • (String) 


2742
2743
2744
2745
2746
2747
2748
2749
 
# File 'lib/aws-sdk-qbusiness/types.rb', line 2742

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