Class: Aws::QBusiness::Types::ListDocumentsRequest

Inherits:

Struct

• Object
• Struct
• Aws::QBusiness::Types::ListDocumentsRequest

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 id the documents are attached to.

• #data_source_ids ⇒ Array<String>

  The identifier of the data sources the documents are attached to.

• #index_id ⇒ String

  The identifier of the index the documents are attached to.

• #max_results ⇒ Integer

  The maximum number of documents to return.

• #next_token ⇒ String

  If the ‘maxResults` response was incomplete because there is more data to retrieve, Amazon Q Business returns a pagination token in the response.

Instance Attribute Details

#application_id ⇒ String

The identifier of the application id the documents are attached to.

Returns:

• (String)

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

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

#data_source_ids ⇒ Array<String>

The identifier of the data sources the documents are attached to.

Returns:

• (Array<String>)

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

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

#index_id ⇒ String

The identifier of the index the documents are attached to.

Returns:

• (String)

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

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

#max_results ⇒ Integer

The maximum number of documents to return.

Returns:

• (Integer)

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

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

#next_token ⇒ String

If the ‘maxResults` 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 documents.

Returns:

• (String)

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

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