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

Inherits:

Struct

• Object
• Struct
• Aws::Kendra::Types::ListFaqsRequest

Defined in:

gems/aws-sdk-kendra/lib/aws-sdk-kendra/types.rb

Overview

See Also:

• AWS API Documentation

Constant Summary

SENSITIVE =

[]

Instance Attribute Summary

• #index_id ⇒ String

  The index that contains the FAQ lists.

• #max_results ⇒ Integer

  The maximum number of FAQs to return in the response.

• #next_token ⇒ String

  If the previous response was incomplete (because there is more data to retrieve), Amazon Kendra returns a pagination token in the response.

Instance Attribute Details

#index_id ⇒ String

The index that contains the FAQ lists.

Returns:

• (String)

# File 'gems/aws-sdk-kendra/lib/aws-sdk-kendra/types.rb', line 7158

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

#max_results ⇒ Integer

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)

# File 'gems/aws-sdk-kendra/lib/aws-sdk-kendra/types.rb', line 7158

class ListFaqsRequest < Struct.new(
  :index_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 Kendra returns a pagination token in the response. You can use this pagination token to retrieve the next set of FAQs.

Returns:

• (String)

# File 'gems/aws-sdk-kendra/lib/aws-sdk-kendra/types.rb', line 7158

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