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

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

Overview

Constant Summary collapse

SENSITIVE =
[]

Instance Attribute Summary collapse

Instance Attribute Details

#application_idString

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

Returns:

  • (String)


5388
5389
5390
5391
5392
5393
5394
5395
5396
5397
# File 'gems/aws-sdk-qbusiness/lib/aws-sdk-qbusiness/types.rb', line 5388

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_idString

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

Returns:

  • (String)


5388
5389
5390
5391
5392
5393
5394
5395
5396
5397
# File 'gems/aws-sdk-qbusiness/lib/aws-sdk-qbusiness/types.rb', line 5388

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

#index_idString

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

Returns:

  • (String)


5388
5389
5390
5391
5392
5393
5394
5395
5396
5397
# File 'gems/aws-sdk-qbusiness/lib/aws-sdk-qbusiness/types.rb', line 5388

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

#max_resultsInteger

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

Returns:

  • (Integer)


5388
5389
5390
5391
5392
5393
5394
5395
5396
5397
# File 'gems/aws-sdk-qbusiness/lib/aws-sdk-qbusiness/types.rb', line 5388

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

#next_tokenString

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)


5388
5389
5390
5391
5392
5393
5394
5395
5396
5397
# File 'gems/aws-sdk-qbusiness/lib/aws-sdk-qbusiness/types.rb', line 5388

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_thanTime

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

Returns:

  • (Time)


5388
5389
5390
5391
5392
5393
5394
5395
5396
5397
# File 'gems/aws-sdk-qbusiness/lib/aws-sdk-qbusiness/types.rb', line 5388

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