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

Network.AWS.IoT.SearchIndex

Contents

Creating a Request
Request Lenses
Destructuring the Response
Response Lenses

Description

The query search index.

Synopsis

Creating a Request

searchIndex Source #

Arguments

:: Text	`siQueryString`
-> SearchIndex

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

Eq SearchIndex Source #
Instance details Defined in Network.AWS.IoT.SearchIndex Methods (==) :: SearchIndex -> SearchIndex -> Bool # (/=) :: SearchIndex -> SearchIndex -> Bool #
Data SearchIndex Source #
Instance details Defined in Network.AWS.IoT.SearchIndex Methods gfoldl :: (forall d b. Data d => c (d -> b) -> d -> c b) -> (forall g. g -> c g) -> SearchIndex -> c SearchIndex # gunfold :: (forall b r. Data b => c (b -> r) -> c r) -> (forall r. r -> c r) -> Constr -> c SearchIndex # toConstr :: SearchIndex -> Constr # dataTypeOf :: SearchIndex -> DataType # dataCast1 :: Typeable t => (forall d. Data d => c (t d)) -> Maybe (c SearchIndex) # dataCast2 :: Typeable t => (forall d e. (Data d, Data e) => c (t d e)) -> Maybe (c SearchIndex) # gmapT :: (forall b. Data b => b -> b) -> SearchIndex -> SearchIndex # gmapQl :: (r -> r' -> r) -> r -> (forall d. Data d => d -> r') -> SearchIndex -> r # gmapQr :: (r' -> r -> r) -> r -> (forall d. Data d => d -> r') -> SearchIndex -> r # gmapQ :: (forall d. Data d => d -> u) -> SearchIndex -> [u] # gmapQi :: Int -> (forall d. Data d => d -> u) -> SearchIndex -> u # gmapM :: Monad m => (forall d. Data d => d -> m d) -> SearchIndex -> m SearchIndex # gmapMp :: MonadPlus m => (forall d. Data d => d -> m d) -> SearchIndex -> m SearchIndex # gmapMo :: MonadPlus m => (forall d. Data d => d -> m d) -> SearchIndex -> m SearchIndex #
Read SearchIndex Source #
Instance details Defined in Network.AWS.IoT.SearchIndex Methods readsPrec :: Int -> ReadS SearchIndex # readList :: ReadS [SearchIndex] # readPrec :: ReadPrec SearchIndex # readListPrec :: ReadPrec [SearchIndex] #
Show SearchIndex Source #
Instance details Defined in Network.AWS.IoT.SearchIndex Methods showsPrec :: Int -> SearchIndex -> ShowS # show :: SearchIndex -> String # showList :: [SearchIndex] -> ShowS #
Generic SearchIndex Source #
Instance details Defined in Network.AWS.IoT.SearchIndex Associated Types type Rep SearchIndex :: Type -> Type # Methods from :: SearchIndex -> Rep SearchIndex x # to :: Rep SearchIndex x -> SearchIndex #
Hashable SearchIndex Source #
Instance details Defined in Network.AWS.IoT.SearchIndex Methods hashWithSalt :: Int -> SearchIndex -> Int # hash :: SearchIndex -> Int #
ToJSON SearchIndex Source #
Instance details Defined in Network.AWS.IoT.SearchIndex Methods toJSON :: SearchIndex -> Value # toEncoding :: SearchIndex -> Encoding # toJSONList :: [SearchIndex] -> Value # toEncodingList :: [SearchIndex] -> Encoding #
AWSRequest SearchIndex Source #
Instance details Defined in Network.AWS.IoT.SearchIndex Associated Types type Rs SearchIndex :: Type # Methods request :: SearchIndex -> Request SearchIndex # response :: (MonadResource m, MonadThrow m) => Logger -> Service -> Proxy SearchIndex -> ClientResponse -> m (Response SearchIndex) #
ToHeaders SearchIndex Source #
Instance details Defined in Network.AWS.IoT.SearchIndex Methods toHeaders :: SearchIndex -> [Header] #
ToPath SearchIndex Source #
Instance details Defined in Network.AWS.IoT.SearchIndex Methods toPath :: SearchIndex -> ByteString #
ToQuery SearchIndex Source #
Instance details Defined in Network.AWS.IoT.SearchIndex Methods toQuery :: SearchIndex -> QueryString #
NFData SearchIndex Source #
Instance details Defined in Network.AWS.IoT.SearchIndex Methods rnf :: SearchIndex -> () #
type Rep SearchIndex Source #
Instance details Defined in Network.AWS.IoT.SearchIndex type Rep SearchIndex = D1 (MetaData "SearchIndex" "Network.AWS.IoT.SearchIndex" "amazonka-iot-1.6.1-1U0NSVSRVsCEeZIE9W0TkV" False) (C1 (MetaCons "SearchIndex'" PrefixI True) ((S1 (MetaSel (Just "_siQueryVersion") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 (Maybe Text)) :: S1 (MetaSel (Just "_siNextToken") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 (Maybe Text))) :: (S1 (MetaSel (Just "_siMaxResults") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 (Maybe Nat)) :: (S1 (MetaSel (Just "_siIndexName") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 (Maybe Text)) :: S1 (MetaSel (Just "_siQueryString") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 Text)))))
type Rs SearchIndex Source #
Instance details Defined in Network.AWS.IoT.SearchIndex type Rs SearchIndex = SearchIndexResponse

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

searchIndexResponse Source #

Arguments

:: Int	`sirsResponseStatus`
-> SearchIndexResponse

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

Eq SearchIndexResponse Source #
Instance details Defined in Network.AWS.IoT.SearchIndex Methods (==) :: SearchIndexResponse -> SearchIndexResponse -> Bool # (/=) :: SearchIndexResponse -> SearchIndexResponse -> Bool #
Data SearchIndexResponse Source #
Instance details Defined in Network.AWS.IoT.SearchIndex Methods gfoldl :: (forall d b. Data d => c (d -> b) -> d -> c b) -> (forall g. g -> c g) -> SearchIndexResponse -> c SearchIndexResponse # gunfold :: (forall b r. Data b => c (b -> r) -> c r) -> (forall r. r -> c r) -> Constr -> c SearchIndexResponse # toConstr :: SearchIndexResponse -> Constr # dataTypeOf :: SearchIndexResponse -> DataType # dataCast1 :: Typeable t => (forall d. Data d => c (t d)) -> Maybe (c SearchIndexResponse) # dataCast2 :: Typeable t => (forall d e. (Data d, Data e) => c (t d e)) -> Maybe (c SearchIndexResponse) # gmapT :: (forall b. Data b => b -> b) -> SearchIndexResponse -> SearchIndexResponse # gmapQl :: (r -> r' -> r) -> r -> (forall d. Data d => d -> r') -> SearchIndexResponse -> r # gmapQr :: (r' -> r -> r) -> r -> (forall d. Data d => d -> r') -> SearchIndexResponse -> r # gmapQ :: (forall d. Data d => d -> u) -> SearchIndexResponse -> [u] # gmapQi :: Int -> (forall d. Data d => d -> u) -> SearchIndexResponse -> u # gmapM :: Monad m => (forall d. Data d => d -> m d) -> SearchIndexResponse -> m SearchIndexResponse # gmapMp :: MonadPlus m => (forall d. Data d => d -> m d) -> SearchIndexResponse -> m SearchIndexResponse # gmapMo :: MonadPlus m => (forall d. Data d => d -> m d) -> SearchIndexResponse -> m SearchIndexResponse #
Read SearchIndexResponse Source #
Instance details Defined in Network.AWS.IoT.SearchIndex Methods readsPrec :: Int -> ReadS SearchIndexResponse # readList :: ReadS [SearchIndexResponse] # readPrec :: ReadPrec SearchIndexResponse # readListPrec :: ReadPrec [SearchIndexResponse] #
Show SearchIndexResponse Source #
Instance details Defined in Network.AWS.IoT.SearchIndex Methods showsPrec :: Int -> SearchIndexResponse -> ShowS # show :: SearchIndexResponse -> String # showList :: [SearchIndexResponse] -> ShowS #
Generic SearchIndexResponse Source #
Instance details Defined in Network.AWS.IoT.SearchIndex Associated Types type Rep SearchIndexResponse :: Type -> Type # Methods from :: SearchIndexResponse -> Rep SearchIndexResponse x # to :: Rep SearchIndexResponse x -> SearchIndexResponse #
NFData SearchIndexResponse Source #
Instance details Defined in Network.AWS.IoT.SearchIndex Methods rnf :: SearchIndexResponse -> () #
type Rep SearchIndexResponse Source #
Instance details Defined in Network.AWS.IoT.SearchIndex type Rep SearchIndexResponse = D1 (MetaData "SearchIndexResponse" "Network.AWS.IoT.SearchIndex" "amazonka-iot-1.6.1-1U0NSVSRVsCEeZIE9W0TkV" False) (C1 (MetaCons "SearchIndexResponse'" PrefixI True) (S1 (MetaSel (Just "_sirsNextToken") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 (Maybe Text)) :: (S1 (MetaSel (Just "_sirsThings") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 (Maybe [ThingDocument])) :: S1 (MetaSel (Just "_sirsResponseStatus") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 Int))))

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.