Copyright | (c) 2013-2018 Brendan Hay |
---|---|
License | Mozilla Public License, v. 2.0. |
Maintainer | Brendan Hay <brendan.g.hay+amazonka@gmail.com> |
Stability | auto-generated |
Portability | non-portable (GHC extensions) |
Safe Haskell | None |
Language | Haskell2010 |
The query search index.
Synopsis
- searchIndex :: Text -> SearchIndex
- data SearchIndex
- siQueryVersion :: Lens' SearchIndex (Maybe Text)
- siNextToken :: Lens' SearchIndex (Maybe Text)
- siMaxResults :: Lens' SearchIndex (Maybe Natural)
- siIndexName :: Lens' SearchIndex (Maybe Text)
- siQueryString :: Lens' SearchIndex Text
- searchIndexResponse :: Int -> SearchIndexResponse
- data SearchIndexResponse
- sirsNextToken :: Lens' SearchIndexResponse (Maybe Text)
- sirsThings :: Lens' SearchIndexResponse [ThingDocument]
- sirsResponseStatus :: Lens' SearchIndexResponse Int
Creating a Request
Creates a value of SearchIndex
with the minimum fields required to make a request.
Use one of the following lenses to modify other fields as desired:
siQueryVersion
- The query version.siNextToken
- The token used to get the next set of results, or null if there are no additional results.siMaxResults
- The maximum number of results to return at one time.siIndexName
- The search index name.siQueryString
- The search query string.
data SearchIndex Source #
See: searchIndex
smart constructor.
Instances
Request Lenses
siQueryVersion :: Lens' SearchIndex (Maybe Text) Source #
The query version.
siNextToken :: Lens' SearchIndex (Maybe Text) Source #
The token used to get the next set of results, or null if there are no additional results.
siMaxResults :: Lens' SearchIndex (Maybe Natural) Source #
The maximum number of results to return at one time.
siIndexName :: Lens' SearchIndex (Maybe Text) Source #
The search index name.
siQueryString :: Lens' SearchIndex Text Source #
The search query string.
Destructuring the Response
Creates a value of SearchIndexResponse
with the minimum fields required to make a request.
Use one of the following lenses to modify other fields as desired:
sirsNextToken
- The token used to get the next set of results, or null if there are no additional results.sirsThings
- The things that match the search query.sirsResponseStatus
- -- | The response status code.
data SearchIndexResponse Source #
See: searchIndexResponse
smart constructor.
Instances
Response Lenses
sirsNextToken :: Lens' SearchIndexResponse (Maybe Text) Source #
The token used to get the next set of results, or null if there are no additional results.
sirsThings :: Lens' SearchIndexResponse [ThingDocument] Source #
The things that match the search query.
sirsResponseStatus :: Lens' SearchIndexResponse Int Source #
- - | The response status code.