Amazonka.Kendra.ListFaqs

Gets a list of FAQ lists associated with an index.

Creating a Request

data ListFaqs

See: newListFaqs smart constructor.

Constructors

ListFaqs'

Fields

• maxResults :: Maybe Natural

  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.

• nextToken :: Maybe Text

  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.

• indexId :: Text

  The index that contains the FAQ lists.

Instances

ToJSON ListFaqs

Defined in Amazonka.Kendra.ListFaqs

Methods

toJSON :: ListFaqs -> Value

toEncoding :: ListFaqs -> Encoding

toJSONList :: [ListFaqs] -> Value

toEncodingList :: [ListFaqs] -> Encoding

ToHeaders ListFaqs

Defined in Amazonka.Kendra.ListFaqs

Methods

toHeaders :: ListFaqs -> [Header]

ToPath ListFaqs

Defined in Amazonka.Kendra.ListFaqs

Methods

toPath :: ListFaqs -> ByteString

ToQuery ListFaqs

Defined in Amazonka.Kendra.ListFaqs

Methods

toQuery :: ListFaqs -> QueryString

AWSRequest ListFaqs

Defined in Amazonka.Kendra.ListFaqs

Associated Types

type AWSResponse ListFaqs

Methods

request :: (Service -> Service) -> ListFaqs -> Request ListFaqs

response :: MonadResource m => (ByteStringLazy -> IO ByteStringLazy) -> Service -> Proxy ListFaqs -> ClientResponse ClientBody -> m (Either Error (ClientResponse (AWSResponse ListFaqs)))

Generic ListFaqs

Defined in Amazonka.Kendra.ListFaqs

Associated Types

type Rep ListFaqs :: Type -> Type

Methods

from :: ListFaqs -> Rep ListFaqs x

to :: Rep ListFaqs x -> ListFaqs

Read ListFaqs

Defined in Amazonka.Kendra.ListFaqs

Methods

readsPrec :: Int -> ReadS ListFaqs

readList :: ReadS [ListFaqs]

readPrec :: ReadPrec ListFaqs

readListPrec :: ReadPrec [ListFaqs]

Show ListFaqs

Defined in Amazonka.Kendra.ListFaqs

Methods

showsPrec :: Int -> ListFaqs -> ShowS

show :: ListFaqs -> String

showList :: [ListFaqs] -> ShowS

NFData ListFaqs

Defined in Amazonka.Kendra.ListFaqs

Methods

rnf :: ListFaqs -> ()

Eq ListFaqs

Defined in Amazonka.Kendra.ListFaqs

Methods

(==) :: ListFaqs -> ListFaqs -> Bool

(/=) :: ListFaqs -> ListFaqs -> Bool

Hashable ListFaqs

Defined in Amazonka.Kendra.ListFaqs

Methods

hashWithSalt :: Int -> ListFaqs -> Int

hash :: ListFaqs -> Int

type AWSResponse ListFaqs

Defined in Amazonka.Kendra.ListFaqs

type AWSResponse ListFaqs = ListFaqsResponse

type Rep ListFaqs

Defined in Amazonka.Kendra.ListFaqs

type Rep ListFaqs = D1 ('MetaData "ListFaqs" "Amazonka.Kendra.ListFaqs" "amazonka-kendra-2.0-IHloXAWlYIS8YTp1gXe6J" 'False) (C1 ('MetaCons "ListFaqs'" 'PrefixI 'True) (S1 ('MetaSel ('Just "maxResults") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Natural)) :*: (S1 ('MetaSel ('Just "nextToken") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :*: S1 ('MetaSel ('Just "indexId") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Text))))

newListFaqs

Arguments

:: Text

$sel:indexId:ListFaqs'

-> ListFaqs

Create a value of ListFaqs with all optional fields omitted.

Use generic-lens or optics to modify other optional fields.

The following record fields are available, with the corresponding lenses provided for backwards compatibility:

ListFaqs, listFaqs_maxResults - 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.

ListFaqs, listFaqs_nextToken - 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.

$sel:indexId:ListFaqs', listFaqs_indexId - The index that contains the FAQ lists.

Request Lenses

listFaqs_maxResults :: Lens' ListFaqs (Maybe Natural)

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.

listFaqs_nextToken :: Lens' ListFaqs (Maybe Text)

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.

listFaqs_indexId :: Lens' ListFaqs Text

The index that contains the FAQ lists.

Destructuring the Response

data ListFaqsResponse

See: newListFaqsResponse smart constructor.

Constructors

ListFaqsResponse'

Fields

• faqSummaryItems :: Maybe [FaqSummary]

  information about the FAQs associated with the specified index.

• nextToken :: Maybe Text

  If the response is truncated, Amazon Kendra returns this token that you can use in the subsequent request to retrieve the next set of FAQs.

• httpStatus :: Int

  The response's http status code.

Instances

Generic ListFaqsResponse

Defined in Amazonka.Kendra.ListFaqs

Associated Types

type Rep ListFaqsResponse :: Type -> Type

Methods

from :: ListFaqsResponse -> Rep ListFaqsResponse x

to :: Rep ListFaqsResponse x -> ListFaqsResponse

Read ListFaqsResponse

Defined in Amazonka.Kendra.ListFaqs

Methods

readsPrec :: Int -> ReadS ListFaqsResponse

readList :: ReadS [ListFaqsResponse]

readPrec :: ReadPrec ListFaqsResponse

readListPrec :: ReadPrec [ListFaqsResponse]

Show ListFaqsResponse

Defined in Amazonka.Kendra.ListFaqs

Methods

showsPrec :: Int -> ListFaqsResponse -> ShowS

show :: ListFaqsResponse -> String

showList :: [ListFaqsResponse] -> ShowS

NFData ListFaqsResponse

Defined in Amazonka.Kendra.ListFaqs

Methods

rnf :: ListFaqsResponse -> ()

Eq ListFaqsResponse

Defined in Amazonka.Kendra.ListFaqs

Methods

(==) :: ListFaqsResponse -> ListFaqsResponse -> Bool

(/=) :: ListFaqsResponse -> ListFaqsResponse -> Bool

type Rep ListFaqsResponse

Defined in Amazonka.Kendra.ListFaqs

type Rep ListFaqsResponse = D1 ('MetaData "ListFaqsResponse" "Amazonka.Kendra.ListFaqs" "amazonka-kendra-2.0-IHloXAWlYIS8YTp1gXe6J" 'False) (C1 ('MetaCons "ListFaqsResponse'" 'PrefixI 'True) (S1 ('MetaSel ('Just "faqSummaryItems") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe [FaqSummary])) :*: (S1 ('MetaSel ('Just "nextToken") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :*: S1 ('MetaSel ('Just "httpStatus") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Int))))

newListFaqsResponse

Arguments

:: Int

$sel:httpStatus:ListFaqsResponse'

-> ListFaqsResponse

Create a value of ListFaqsResponse with all optional fields omitted.

Use generic-lens or optics to modify other optional fields.

The following record fields are available, with the corresponding lenses provided for backwards compatibility:

$sel:faqSummaryItems:ListFaqsResponse', listFaqsResponse_faqSummaryItems - information about the FAQs associated with the specified index.

ListFaqs, listFaqsResponse_nextToken - If the response is truncated, Amazon Kendra returns this token that you can use in the subsequent request to retrieve the next set of FAQs.

$sel:httpStatus:ListFaqsResponse', listFaqsResponse_httpStatus - The response's http status code.

Response Lenses

listFaqsResponse_faqSummaryItems :: Lens' ListFaqsResponse (Maybe [FaqSummary])

information about the FAQs associated with the specified index.

listFaqsResponse_nextToken :: Lens' ListFaqsResponse (Maybe Text)

If the response is truncated, Amazon Kendra returns this token that you can use in the subsequent request to retrieve the next set of FAQs.

listFaqsResponse_httpStatus :: Lens' ListFaqsResponse Int

The response's http status code.