Network.AWS.IoT.SearchIndex

The query search index.

Creating a Request

searchIndex

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

See: searchIndex smart constructor.

Instances

Eq SearchIndex

Methods

(==) :: SearchIndex -> SearchIndex -> Bool

(/=) :: SearchIndex -> SearchIndex -> Bool

Data 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

Methods

readsPrec :: Int -> ReadS SearchIndex

readList :: ReadS [SearchIndex]

readPrec :: ReadPrec SearchIndex

readListPrec :: ReadPrec [SearchIndex]

Show SearchIndex

Methods

showsPrec :: Int -> SearchIndex -> ShowS

show :: SearchIndex -> String

showList :: [SearchIndex] -> ShowS

Generic SearchIndex

Associated Types

type Rep SearchIndex :: * -> *

Methods

from :: SearchIndex -> Rep SearchIndex x

to :: Rep SearchIndex x -> SearchIndex

Hashable SearchIndex

Methods

hashWithSalt :: Int -> SearchIndex -> Int

hash :: SearchIndex -> Int

ToJSON SearchIndex

Methods

toJSON :: SearchIndex -> Value

toEncoding :: SearchIndex -> Encoding

toJSONList :: [SearchIndex] -> Value

toEncodingList :: [SearchIndex] -> Encoding

NFData SearchIndex

Methods

rnf :: SearchIndex -> ()

AWSRequest SearchIndex

Associated Types

type Rs SearchIndex :: *

Methods

request :: SearchIndex -> Request SearchIndex

response :: (MonadResource m, MonadThrow m) => Logger -> Service -> Proxy * SearchIndex -> ClientResponse -> m (Response SearchIndex)

ToHeaders SearchIndex

Methods

toHeaders :: SearchIndex -> [Header]

ToPath SearchIndex

Methods

toPath :: SearchIndex -> ByteString

ToQuery SearchIndex

Methods

toQuery :: SearchIndex -> QueryString

type Rep SearchIndex

type Rep SearchIndex = D1 * (MetaData "SearchIndex" "Network.AWS.IoT.SearchIndex" "amazonka-iot-1.6.0-GZYdsKS1TEjHFZo6BqaYJk" False) (C1 * (MetaCons "SearchIndex'" PrefixI True) ((:*:) * ((:*:) * (S1 * (MetaSel (Just Symbol "_siQueryVersion") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 * (Maybe Text))) (S1 * (MetaSel (Just Symbol "_siNextToken") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 * (Maybe Text)))) ((:*:) * (S1 * (MetaSel (Just Symbol "_siMaxResults") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 * (Maybe Nat))) ((:*:) * (S1 * (MetaSel (Just Symbol "_siIndexName") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 * (Maybe Text))) (S1 * (MetaSel (Just Symbol "_siQueryString") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 * Text))))))

type Rs SearchIndex

type Rs SearchIndex = SearchIndexResponse

Request Lenses

siQueryVersion :: Lens' SearchIndex (Maybe Text)

The query version.

siNextToken :: Lens' SearchIndex (Maybe Text)

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

siMaxResults :: Lens' SearchIndex (Maybe Natural)

The maximum number of results to return at one time.

siIndexName :: Lens' SearchIndex (Maybe Text)

The search index name.

siQueryString :: Lens' SearchIndex Text

The search query string.

Destructuring the Response

searchIndexResponse

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

See: searchIndexResponse smart constructor.

Instances

Eq SearchIndexResponse

Methods

(==) :: SearchIndexResponse -> SearchIndexResponse -> Bool

(/=) :: SearchIndexResponse -> SearchIndexResponse -> Bool

Data SearchIndexResponse

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

Methods

readsPrec :: Int -> ReadS SearchIndexResponse

readList :: ReadS [SearchIndexResponse]

readPrec :: ReadPrec SearchIndexResponse

readListPrec :: ReadPrec [SearchIndexResponse]

Show SearchIndexResponse

Methods

showsPrec :: Int -> SearchIndexResponse -> ShowS

show :: SearchIndexResponse -> String

showList :: [SearchIndexResponse] -> ShowS

Generic SearchIndexResponse

Associated Types

type Rep SearchIndexResponse :: * -> *

Methods

from :: SearchIndexResponse -> Rep SearchIndexResponse x

to :: Rep SearchIndexResponse x -> SearchIndexResponse

NFData SearchIndexResponse

Methods

rnf :: SearchIndexResponse -> ()

type Rep SearchIndexResponse

type Rep SearchIndexResponse = D1 * (MetaData "SearchIndexResponse" "Network.AWS.IoT.SearchIndex" "amazonka-iot-1.6.0-GZYdsKS1TEjHFZo6BqaYJk" False) (C1 * (MetaCons "SearchIndexResponse'" PrefixI True) ((:*:) * (S1 * (MetaSel (Just Symbol "_sirsNextToken") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 * (Maybe Text))) ((:*:) * (S1 * (MetaSel (Just Symbol "_sirsThings") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 * (Maybe [ThingDocument]))) (S1 * (MetaSel (Just Symbol "_sirsResponseStatus") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 * Int)))))

Response Lenses

sirsNextToken :: Lens' SearchIndexResponse (Maybe Text)

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

sirsThings :: Lens' SearchIndexResponse [ThingDocument]

The things that match the search query.

sirsResponseStatus :: Lens' SearchIndexResponse Int

• - | The response status code.