Class: Aws::Kendra::Types::ListFaqsRequest

Inherits:
Struct
  • Object
show all
Includes:
Structure
Defined in:
lib/aws-sdk-kendra/types.rb

Overview

Note:

When making an API call, you may pass ListFaqsRequest data as a hash:

{
  index_id: "IndexId", # required
  next_token: "NextToken",
  max_results: 1,
}

Constant Summary collapse

SENSITIVE =
[]

Instance Attribute Summary collapse

Instance Attribute Details

#index_idString

The index that contains the FAQ lists.

Returns:

  • (String)

4023
4024
4025
4026
4027
4028
4029
# File 'lib/aws-sdk-kendra/types.rb', line 4023

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

#max_resultsInteger

The maximum number of FAQs to return in the response. If there are fewer results in the list, this response contains only the actual results.

Returns:

  • (Integer)

4023
4024
4025
4026
4027
4028
4029
# File 'lib/aws-sdk-kendra/types.rb', line 4023

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

#next_tokenString

If the result of the previous request to `ListFaqs` was truncated, include the `NextToken` to fetch the next set of FAQs.

Returns:

  • (String)

4023
4024
4025
4026
4027
4028
4029
# File 'lib/aws-sdk-kendra/types.rb', line 4023

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