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

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

Returns:

  • (String) 


4109
4110
4111
4112
4113
4114
4115
4116
4117
 
# File 'gems/aws-sdk-qbusiness/lib/aws-sdk-qbusiness/types.rb', line 4109

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>) 


4109
4110
4111
4112
4113
4114
4115
4116
4117
 
# File 'gems/aws-sdk-qbusiness/lib/aws-sdk-qbusiness/types.rb', line 4109

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) 


4109
4110
4111
4112
4113
4114
4115
4116
4117
 
# File 'gems/aws-sdk-qbusiness/lib/aws-sdk-qbusiness/types.rb', line 4109

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) 


4109
4110
4111
4112
4113
4114
4115
4116
4117
 
# File 'gems/aws-sdk-qbusiness/lib/aws-sdk-qbusiness/types.rb', line 4109

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) 


4109
4110
4111
4112
4113
4114
4115
4116
4117
 
# File 'gems/aws-sdk-qbusiness/lib/aws-sdk-qbusiness/types.rb', line 4109

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