Class: Aws::QBusiness::Types::ListGroupsRequest

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 for getting a list of groups mapped to users.

Returns:

  • (String) 


4172
4173
4174
4175
4176
4177
4178
4179
4180
4181
 
# File 'gems/aws-sdk-qbusiness/lib/aws-sdk-qbusiness/types.rb', line 4172

class ListGroupsRequest < Struct.new(
  :application_id,
  :index_id,
  :updated_earlier_than,
  :data_source_id,
  :next_token,
  :max_results)
  SENSITIVE = []
  include Aws::Structure
end

#data_source_id ⇒ String

The identifier of the data source for getting a list of groups mapped to users.

Returns:

  • (String) 


4172
4173
4174
4175
4176
4177
4178
4179
4180
4181
 
# File 'gems/aws-sdk-qbusiness/lib/aws-sdk-qbusiness/types.rb', line 4172

class ListGroupsRequest < Struct.new(
  :application_id,
  :index_id,
  :updated_earlier_than,
  :data_source_id,
  :next_token,
  :max_results)
  SENSITIVE = []
  include Aws::Structure
end

#index_id ⇒ String

The identifier of the index for getting a list of groups mapped to users.

Returns:

  • (String) 


4172
4173
4174
4175
4176
4177
4178
4179
4180
4181
 
# File 'gems/aws-sdk-qbusiness/lib/aws-sdk-qbusiness/types.rb', line 4172

class ListGroupsRequest < Struct.new(
  :application_id,
  :index_id,
  :updated_earlier_than,
  :data_source_id,
  :next_token,
  :max_results)
  SENSITIVE = []
  include Aws::Structure
end

#max_results ⇒ Integer

The maximum number of returned groups that are mapped to users.

Returns:

  • (Integer) 


4172
4173
4174
4175
4176
4177
4178
4179
4180
4181
 
# File 'gems/aws-sdk-qbusiness/lib/aws-sdk-qbusiness/types.rb', line 4172

class ListGroupsRequest < Struct.new(
  :application_id,
  :index_id,
  :updated_earlier_than,
  :data_source_id,
  :next_token,
  :max_results)
  SENSITIVE = []
  include Aws::Structure
end

#next_token ⇒ String

If the previous response was incomplete (because there is more data to retrieve), Amazon Q Business returns a pagination token in the response. You can use this pagination token to retrieve the next set of groups that are mapped to users.

Returns:

  • (String) 


4172
4173
4174
4175
4176
4177
4178
4179
4180
4181
 
# File 'gems/aws-sdk-qbusiness/lib/aws-sdk-qbusiness/types.rb', line 4172

class ListGroupsRequest < Struct.new(
  :application_id,
  :index_id,
  :updated_earlier_than,
  :data_source_id,
  :next_token,
  :max_results)
  SENSITIVE = []
  include Aws::Structure
end

#updated_earlier_than ⇒ Time

The timestamp identifier used for the latest PUT or DELETE action for mapping users to their groups.

Returns:

  • (Time) 


4172
4173
4174
4175
4176
4177
4178
4179
4180
4181
 
# File 'gems/aws-sdk-qbusiness/lib/aws-sdk-qbusiness/types.rb', line 4172

class ListGroupsRequest < Struct.new(
  :application_id,
  :index_id,
  :updated_earlier_than,
  :data_source_id,
  :next_token,
  :max_results)
  SENSITIVE = []
  include Aws::Structure
end