| 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 |
Amazonka.Kendra.ListQuerySuggestionsBlockLists
Description
Lists the block lists used for query suggestions for an index.
For information on the current quota limits for block lists, see Quotas for Amazon Kendra.
ListQuerySuggestionsBlockLists is currently not supported in the
Amazon Web Services GovCloud (US-West) region.
Synopsis
- data ListQuerySuggestionsBlockLists = ListQuerySuggestionsBlockLists' {}
- newListQuerySuggestionsBlockLists :: Text -> ListQuerySuggestionsBlockLists
- listQuerySuggestionsBlockLists_maxResults :: Lens' ListQuerySuggestionsBlockLists (Maybe Natural)
- listQuerySuggestionsBlockLists_nextToken :: Lens' ListQuerySuggestionsBlockLists (Maybe Text)
- listQuerySuggestionsBlockLists_indexId :: Lens' ListQuerySuggestionsBlockLists Text
- data ListQuerySuggestionsBlockListsResponse = ListQuerySuggestionsBlockListsResponse' {}
- newListQuerySuggestionsBlockListsResponse :: Int -> ListQuerySuggestionsBlockListsResponse
- listQuerySuggestionsBlockListsResponse_blockListSummaryItems :: Lens' ListQuerySuggestionsBlockListsResponse (Maybe [QuerySuggestionsBlockListSummary])
- listQuerySuggestionsBlockListsResponse_nextToken :: Lens' ListQuerySuggestionsBlockListsResponse (Maybe Text)
- listQuerySuggestionsBlockListsResponse_httpStatus :: Lens' ListQuerySuggestionsBlockListsResponse Int
Creating a Request
data ListQuerySuggestionsBlockLists Source #
See: newListQuerySuggestionsBlockLists smart constructor.
Constructors
| ListQuerySuggestionsBlockLists' | |
Fields
| |
Instances
newListQuerySuggestionsBlockLists Source #
Create a value of ListQuerySuggestionsBlockLists 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:
ListQuerySuggestionsBlockLists, listQuerySuggestionsBlockLists_maxResults - The maximum number of block lists to return.
ListQuerySuggestionsBlockLists, listQuerySuggestionsBlockLists_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 block lists
(BlockListSummaryItems).
$sel:indexId:ListQuerySuggestionsBlockLists', listQuerySuggestionsBlockLists_indexId - The identifier of the index for a list of all block lists that exist for
that index.
For information on the current quota limits for block lists, see Quotas for Amazon Kendra.
Request Lenses
listQuerySuggestionsBlockLists_maxResults :: Lens' ListQuerySuggestionsBlockLists (Maybe Natural) Source #
The maximum number of block lists to return.
listQuerySuggestionsBlockLists_nextToken :: Lens' ListQuerySuggestionsBlockLists (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 block lists
(BlockListSummaryItems).
listQuerySuggestionsBlockLists_indexId :: Lens' ListQuerySuggestionsBlockLists Text Source #
The identifier of the index for a list of all block lists that exist for that index.
For information on the current quota limits for block lists, see Quotas for Amazon Kendra.
Destructuring the Response
data ListQuerySuggestionsBlockListsResponse Source #
See: newListQuerySuggestionsBlockListsResponse smart constructor.
Constructors
| ListQuerySuggestionsBlockListsResponse' | |
Fields
| |
Instances
newListQuerySuggestionsBlockListsResponse Source #
Arguments
| :: Int | |
| -> ListQuerySuggestionsBlockListsResponse |
Create a value of ListQuerySuggestionsBlockListsResponse 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:blockListSummaryItems:ListQuerySuggestionsBlockListsResponse', listQuerySuggestionsBlockListsResponse_blockListSummaryItems - Summary items for a block list.
This includes summary items on the block list ID, block list name, when the block list was created, when the block list was last updated, and the count of block words/phrases in the block list.
For information on the current quota limits for block lists, see Quotas for Amazon Kendra.
ListQuerySuggestionsBlockLists, listQuerySuggestionsBlockListsResponse_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 block
lists.
$sel:httpStatus:ListQuerySuggestionsBlockListsResponse', listQuerySuggestionsBlockListsResponse_httpStatus - The response's http status code.
Response Lenses
listQuerySuggestionsBlockListsResponse_blockListSummaryItems :: Lens' ListQuerySuggestionsBlockListsResponse (Maybe [QuerySuggestionsBlockListSummary]) Source #
Summary items for a block list.
This includes summary items on the block list ID, block list name, when the block list was created, when the block list was last updated, and the count of block words/phrases in the block list.
For information on the current quota limits for block lists, see Quotas for Amazon Kendra.
listQuerySuggestionsBlockListsResponse_nextToken :: Lens' ListQuerySuggestionsBlockListsResponse (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 block lists.
listQuerySuggestionsBlockListsResponse_httpStatus :: Lens' ListQuerySuggestionsBlockListsResponse Int Source #
The response's http status code.