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

Inherits:

Struct

• Object
• Struct
• Aws::QBusiness::Types::ListGroupsRequest

Includes:

Structure

Defined in:

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

• #data_source_id ⇒ String

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

• #index_id ⇒ String

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

• #max_results ⇒ Integer

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

• #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.

• #updated_earlier_than ⇒ Time

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

Instance Attribute Details

#application_id ⇒ String

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

Returns:

• (String)

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

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)

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

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)

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

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)

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

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)

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

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)

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

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