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.IoT.SearchIndex

Contents

Description

The query search index.

Requires permission to access the SearchIndex action.

Synopsis

data SearchIndex = SearchIndex' {
- indexName :: Maybe Text
- maxResults :: Maybe Natural
- nextToken :: Maybe Text
- queryVersion :: Maybe Text
- queryString :: Text
}
newSearchIndex :: Text -> SearchIndex
searchIndex_indexName :: Lens' SearchIndex (Maybe Text)
searchIndex_maxResults :: Lens' SearchIndex (Maybe Natural)
searchIndex_nextToken :: Lens' SearchIndex (Maybe Text)
searchIndex_queryVersion :: Lens' SearchIndex (Maybe Text)
searchIndex_queryString :: Lens' SearchIndex Text
data SearchIndexResponse = SearchIndexResponse' {
- nextToken :: Maybe Text
- thingGroups :: Maybe [ThingGroupDocument]
- things :: Maybe [ThingDocument]
- httpStatus :: Int
}
newSearchIndexResponse :: Int -> SearchIndexResponse
searchIndexResponse_nextToken :: Lens' SearchIndexResponse (Maybe Text)
searchIndexResponse_thingGroups :: Lens' SearchIndexResponse (Maybe [ThingGroupDocument])
searchIndexResponse_things :: Lens' SearchIndexResponse (Maybe [ThingDocument])
searchIndexResponse_httpStatus :: Lens' SearchIndexResponse Int

Creating a Request

data SearchIndex Source #

See: newSearchIndex smart constructor.

Constructors

SearchIndex'

Fields

indexName :: Maybe Text
The search index name.
maxResults :: Maybe Natural
The maximum number of results to return at one time.
nextToken :: Maybe Text
The token used to get the next set of results, or null if there are no additional results.
queryVersion :: Maybe Text
The query version.
queryString :: Text
The search query string. For more information about the search query syntax, see Query syntax.

Instances

Instances details

ToJSON SearchIndex Source #
Instance details Defined in Amazonka.IoT.SearchIndex Methods toJSON :: SearchIndex -> Value # toEncoding :: SearchIndex -> Encoding # toJSONList :: [SearchIndex] -> Value # toEncodingList :: [SearchIndex] -> Encoding #
ToHeaders SearchIndex Source #
Instance details Defined in Amazonka.IoT.SearchIndex Methods toHeaders :: SearchIndex -> [Header] #
ToPath SearchIndex Source #
Instance details Defined in Amazonka.IoT.SearchIndex Methods toPath :: SearchIndex -> ByteString #
ToQuery SearchIndex Source #
Instance details Defined in Amazonka.IoT.SearchIndex Methods toQuery :: SearchIndex -> QueryString #
AWSRequest SearchIndex Source #
Instance details Defined in Amazonka.IoT.SearchIndex Associated Types type AWSResponse SearchIndex # Methods request :: (Service -> Service) -> SearchIndex -> Request SearchIndex # response :: MonadResource m => (ByteStringLazy -> IO ByteStringLazy) -> Service -> Proxy SearchIndex -> ClientResponse ClientBody -> m (Either Error (ClientResponse (AWSResponse SearchIndex))) #
Generic SearchIndex Source #
Instance details Defined in Amazonka.IoT.SearchIndex Associated Types type Rep SearchIndex :: Type -> Type # Methods from :: SearchIndex -> Rep SearchIndex x # to :: Rep SearchIndex x -> SearchIndex #
Read SearchIndex Source #
Instance details Defined in Amazonka.IoT.SearchIndex Methods readsPrec :: Int -> ReadS SearchIndex # readList :: ReadS [SearchIndex] # readPrec :: ReadPrec SearchIndex # readListPrec :: ReadPrec [SearchIndex] #
Show SearchIndex Source #
Instance details Defined in Amazonka.IoT.SearchIndex Methods showsPrec :: Int -> SearchIndex -> ShowS # show :: SearchIndex -> String # showList :: [SearchIndex] -> ShowS #
NFData SearchIndex Source #
Instance details Defined in Amazonka.IoT.SearchIndex Methods rnf :: SearchIndex -> () #
Eq SearchIndex Source #
Instance details Defined in Amazonka.IoT.SearchIndex Methods (==) :: SearchIndex -> SearchIndex -> Bool # (/=) :: SearchIndex -> SearchIndex -> Bool #
Hashable SearchIndex Source #
Instance details Defined in Amazonka.IoT.SearchIndex Methods hashWithSalt :: Int -> SearchIndex -> Int # hash :: SearchIndex -> Int #
type AWSResponse SearchIndex Source #
Instance details Defined in Amazonka.IoT.SearchIndex type AWSResponse SearchIndex = SearchIndexResponse
type Rep SearchIndex Source #
Instance details Defined in Amazonka.IoT.SearchIndex type Rep SearchIndex = D1 ('MetaData "SearchIndex" "Amazonka.IoT.SearchIndex" "amazonka-iot-2.0-6w03vgAfmrM1SG22OsNJXL" 'False) (C1 ('MetaCons "SearchIndex'" 'PrefixI 'True) ((S1 ('MetaSel ('Just "indexName") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :: S1 ('MetaSel ('Just "maxResults") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Natural))) :: (S1 ('MetaSel ('Just "nextToken") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :: (S1 ('MetaSel ('Just "queryVersion") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :: S1 ('MetaSel ('Just "queryString") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Text)))))

newSearchIndex Source #

Arguments

:: Text	`SearchIndex`
-> SearchIndex

Create a value of SearchIndex 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:indexName:SearchIndex', searchIndex_indexName - The search index name.

$sel:maxResults:SearchIndex', searchIndex_maxResults - The maximum number of results to return at one time.

SearchIndex, searchIndex_nextToken - The token used to get the next set of results, or null if there are no additional results.

$sel:queryVersion:SearchIndex', searchIndex_queryVersion - The query version.

SearchIndex, searchIndex_queryString - The search query string. For more information about the search query syntax, see Query syntax.

Request Lenses

searchIndex_indexName :: Lens' SearchIndex (Maybe Text) Source #

The search index name.

searchIndex_maxResults :: Lens' SearchIndex (Maybe Natural) Source #

The maximum number of results to return at one time.

searchIndex_nextToken :: Lens' SearchIndex (Maybe Text) Source #

The token used to get the next set of results, or null if there are no additional results.

searchIndex_queryVersion :: Lens' SearchIndex (Maybe Text) Source #

The query version.

searchIndex_queryString :: Lens' SearchIndex Text Source #

The search query string. For more information about the search query syntax, see Query syntax.

Destructuring the Response

data SearchIndexResponse Source #

See: newSearchIndexResponse smart constructor.

Constructors

SearchIndexResponse'
Fields nextToken :: Maybe Text The token used to get the next set of results, or `null` if there are no additional results. thingGroups :: Maybe [ThingGroupDocument] The thing groups that match the search query. things :: Maybe [ThingDocument] The things that match the search query. httpStatus :: Int The response's http status code.

Instances

Instances details

Generic SearchIndexResponse Source #
Instance details Defined in Amazonka.IoT.SearchIndex Associated Types type Rep SearchIndexResponse :: Type -> Type # Methods from :: SearchIndexResponse -> Rep SearchIndexResponse x # to :: Rep SearchIndexResponse x -> SearchIndexResponse #
Read SearchIndexResponse Source #
Instance details Defined in Amazonka.IoT.SearchIndex Methods readsPrec :: Int -> ReadS SearchIndexResponse # readList :: ReadS [SearchIndexResponse] # readPrec :: ReadPrec SearchIndexResponse # readListPrec :: ReadPrec [SearchIndexResponse] #
Show SearchIndexResponse Source #
Instance details Defined in Amazonka.IoT.SearchIndex Methods showsPrec :: Int -> SearchIndexResponse -> ShowS # show :: SearchIndexResponse -> String # showList :: [SearchIndexResponse] -> ShowS #
NFData SearchIndexResponse Source #
Instance details Defined in Amazonka.IoT.SearchIndex Methods rnf :: SearchIndexResponse -> () #
Eq SearchIndexResponse Source #
Instance details Defined in Amazonka.IoT.SearchIndex Methods (==) :: SearchIndexResponse -> SearchIndexResponse -> Bool # (/=) :: SearchIndexResponse -> SearchIndexResponse -> Bool #
type Rep SearchIndexResponse Source #
Instance details Defined in Amazonka.IoT.SearchIndex type Rep SearchIndexResponse = D1 ('MetaData "SearchIndexResponse" "Amazonka.IoT.SearchIndex" "amazonka-iot-2.0-6w03vgAfmrM1SG22OsNJXL" 'False) (C1 ('MetaCons "SearchIndexResponse'" 'PrefixI 'True) ((S1 ('MetaSel ('Just "nextToken") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :: S1 ('MetaSel ('Just "thingGroups") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe [ThingGroupDocument]))) :: (S1 ('MetaSel ('Just "things") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe [ThingDocument])) :*: S1 ('MetaSel ('Just "httpStatus") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Int))))

newSearchIndexResponse Source #

Arguments

:: Int	`$sel:httpStatus:SearchIndexResponse'`
-> SearchIndexResponse

Create a value of SearchIndexResponse 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:

SearchIndex, searchIndexResponse_nextToken - The token used to get the next set of results, or null if there are no additional results.

$sel:thingGroups:SearchIndexResponse', searchIndexResponse_thingGroups - The thing groups that match the search query.

$sel:things:SearchIndexResponse', searchIndexResponse_things - The things that match the search query.

$sel:httpStatus:SearchIndexResponse', searchIndexResponse_httpStatus - The response's http status code.

Response Lenses

searchIndexResponse_nextToken :: Lens' SearchIndexResponse (Maybe Text) Source #

The token used to get the next set of results, or null if there are no additional results.

searchIndexResponse_thingGroups :: Lens' SearchIndexResponse (Maybe [ThingGroupDocument]) Source #

The thing groups that match the search query.

searchIndexResponse_things :: Lens' SearchIndexResponse (Maybe [ThingDocument]) Source #

The things that match the search query.

searchIndexResponse_httpStatus :: Lens' SearchIndexResponse Int Source #

The response's http status code.