Copyright | (c) 2013-2023 Brendan Hay |
---|---|
License | Mozilla Public License, v. 2.0. |
Maintainer | Brendan Hay |
Stability | auto-generated |
Portability | non-portable (GHC extensions) |
Safe Haskell | Safe-Inferred |
Language | Haskell2010 |
Lists the thesauri for an index.
Synopsis
- data ListThesauri = ListThesauri' {}
- newListThesauri :: Text -> ListThesauri
- listThesauri_maxResults :: Lens' ListThesauri (Maybe Natural)
- listThesauri_nextToken :: Lens' ListThesauri (Maybe Text)
- listThesauri_indexId :: Lens' ListThesauri Text
- data ListThesauriResponse = ListThesauriResponse' {}
- newListThesauriResponse :: Int -> ListThesauriResponse
- listThesauriResponse_nextToken :: Lens' ListThesauriResponse (Maybe Text)
- listThesauriResponse_thesaurusSummaryItems :: Lens' ListThesauriResponse (Maybe [ThesaurusSummary])
- listThesauriResponse_httpStatus :: Lens' ListThesauriResponse Int
Creating a Request
data ListThesauri Source #
See: newListThesauri
smart constructor.
ListThesauri' | |
|
Instances
Create a value of ListThesauri
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:
ListThesauri
, listThesauri_maxResults
- The maximum number of thesauri to return.
ListThesauri
, listThesauri_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 thesauri
(ThesaurusSummaryItems
).
$sel:indexId:ListThesauri'
, listThesauri_indexId
- The identifier of the index with one or more thesauri.
Request Lenses
listThesauri_maxResults :: Lens' ListThesauri (Maybe Natural) Source #
The maximum number of thesauri to return.
listThesauri_nextToken :: Lens' ListThesauri (Maybe Text) Source #
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 thesauri
(ThesaurusSummaryItems
).
listThesauri_indexId :: Lens' ListThesauri Text Source #
The identifier of the index with one or more thesauri.
Destructuring the Response
data ListThesauriResponse Source #
See: newListThesauriResponse
smart constructor.
ListThesauriResponse' | |
|
Instances
newListThesauriResponse Source #
Create a value of ListThesauriResponse
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:
ListThesauri
, listThesauriResponse_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 thesauri.
$sel:thesaurusSummaryItems:ListThesauriResponse'
, listThesauriResponse_thesaurusSummaryItems
- An array of summary information for a thesaurus or multiple thesauri.
$sel:httpStatus:ListThesauriResponse'
, listThesauriResponse_httpStatus
- The response's http status code.
Response Lenses
listThesauriResponse_nextToken :: Lens' ListThesauriResponse (Maybe Text) Source #
If the response is truncated, Amazon Kendra returns this token that you can use in the subsequent request to retrieve the next set of thesauri.
listThesauriResponse_thesaurusSummaryItems :: Lens' ListThesauriResponse (Maybe [ThesaurusSummary]) Source #
An array of summary information for a thesaurus or multiple thesauri.
listThesauriResponse_httpStatus :: Lens' ListThesauriResponse Int Source #
The response's http status code.