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.CloudSearch.IndexDocuments

Contents

Creating a Request
Request Lenses
Destructuring the Response
Response Lenses

Description

Tells the search domain to start indexing its documents using the latest indexing options. This operation must be invoked to activate options whose OptionStatus is RequiresIndexDocuments .

Synopsis

Creating a Request

indexDocuments #

Arguments

:: Text	`idDomainName`
-> IndexDocuments

Creates a value of IndexDocuments with the minimum fields required to make a request.

Use one of the following lenses to modify other fields as desired:

idDomainName - Undocumented member.

data IndexDocuments #

Container for the parameters to the IndexDocuments operation. Specifies the name of the domain you want to re-index.

See: indexDocuments smart constructor.

Instances

Eq IndexDocuments #
Instance details Defined in Network.AWS.CloudSearch.IndexDocuments Methods (==) :: IndexDocuments -> IndexDocuments -> Bool # (/=) :: IndexDocuments -> IndexDocuments -> Bool #
Data IndexDocuments #
Instance details Defined in Network.AWS.CloudSearch.IndexDocuments Methods gfoldl :: (forall d b. Data d => c (d -> b) -> d -> c b) -> (forall g. g -> c g) -> IndexDocuments -> c IndexDocuments # gunfold :: (forall b r. Data b => c (b -> r) -> c r) -> (forall r. r -> c r) -> Constr -> c IndexDocuments # toConstr :: IndexDocuments -> Constr # dataTypeOf :: IndexDocuments -> DataType # dataCast1 :: Typeable t => (forall d. Data d => c (t d)) -> Maybe (c IndexDocuments) # dataCast2 :: Typeable t => (forall d e. (Data d, Data e) => c (t d e)) -> Maybe (c IndexDocuments) # gmapT :: (forall b. Data b => b -> b) -> IndexDocuments -> IndexDocuments # gmapQl :: (r -> r' -> r) -> r -> (forall d. Data d => d -> r') -> IndexDocuments -> r # gmapQr :: (r' -> r -> r) -> r -> (forall d. Data d => d -> r') -> IndexDocuments -> r # gmapQ :: (forall d. Data d => d -> u) -> IndexDocuments -> [u] # gmapQi :: Int -> (forall d. Data d => d -> u) -> IndexDocuments -> u # gmapM :: Monad m => (forall d. Data d => d -> m d) -> IndexDocuments -> m IndexDocuments # gmapMp :: MonadPlus m => (forall d. Data d => d -> m d) -> IndexDocuments -> m IndexDocuments # gmapMo :: MonadPlus m => (forall d. Data d => d -> m d) -> IndexDocuments -> m IndexDocuments #
Read IndexDocuments #
Instance details Defined in Network.AWS.CloudSearch.IndexDocuments Methods readsPrec :: Int -> ReadS IndexDocuments # readList :: ReadS [IndexDocuments] # readPrec :: ReadPrec IndexDocuments # readListPrec :: ReadPrec [IndexDocuments] #
Show IndexDocuments #
Instance details Defined in Network.AWS.CloudSearch.IndexDocuments Methods showsPrec :: Int -> IndexDocuments -> ShowS # show :: IndexDocuments -> String # showList :: [IndexDocuments] -> ShowS #
Generic IndexDocuments #
Instance details Defined in Network.AWS.CloudSearch.IndexDocuments Associated Types type Rep IndexDocuments :: * -> * # Methods from :: IndexDocuments -> Rep IndexDocuments x # to :: Rep IndexDocuments x -> IndexDocuments #
Hashable IndexDocuments #
Instance details Defined in Network.AWS.CloudSearch.IndexDocuments Methods hashWithSalt :: Int -> IndexDocuments -> Int # hash :: IndexDocuments -> Int #
AWSRequest IndexDocuments #
Instance details Defined in Network.AWS.CloudSearch.IndexDocuments Associated Types type Rs IndexDocuments :: * # Methods request :: IndexDocuments -> Request IndexDocuments # response :: (MonadResource m, MonadThrow m) => Logger -> Service -> Proxy IndexDocuments -> ClientResponse -> m (Response IndexDocuments) #
ToHeaders IndexDocuments #
Instance details Defined in Network.AWS.CloudSearch.IndexDocuments Methods toHeaders :: IndexDocuments -> [Header] #
ToPath IndexDocuments #
Instance details Defined in Network.AWS.CloudSearch.IndexDocuments Methods toPath :: IndexDocuments -> ByteString #
ToQuery IndexDocuments #
Instance details Defined in Network.AWS.CloudSearch.IndexDocuments Methods toQuery :: IndexDocuments -> QueryString #
NFData IndexDocuments #
Instance details Defined in Network.AWS.CloudSearch.IndexDocuments Methods rnf :: IndexDocuments -> () #
type Rep IndexDocuments #
Instance details Defined in Network.AWS.CloudSearch.IndexDocuments type Rep IndexDocuments = D1 (MetaData "IndexDocuments" "Network.AWS.CloudSearch.IndexDocuments" "amazonka-cloudsearch-1.6.0-C9KDnoOihM1BDmnzNS5XoR" True) (C1 (MetaCons "IndexDocuments'" PrefixI True) (S1 (MetaSel (Just "_idDomainName") NoSourceUnpackedness NoSourceStrictness DecidedLazy) (Rec0 Text)))
type Rs IndexDocuments #
Instance details Defined in Network.AWS.CloudSearch.IndexDocuments type Rs IndexDocuments = IndexDocumentsResponse

Request Lenses

idDomainName :: Lens' IndexDocuments Text #

Undocumented member.

Destructuring the Response

indexDocumentsResponse #

Arguments

:: Int	`idrsResponseStatus`
-> IndexDocumentsResponse

Creates a value of IndexDocumentsResponse with the minimum fields required to make a request.

Use one of the following lenses to modify other fields as desired:

idrsFieldNames - The names of the fields that are currently being indexed.
idrsResponseStatus - -- | The response status code.

data IndexDocumentsResponse #

The result of an IndexDocuments request. Contains the status of the indexing operation, including the fields being indexed.

See: indexDocumentsResponse smart constructor.

Instances

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

Response Lenses

idrsFieldNames :: Lens' IndexDocumentsResponse [Text] #

The names of the fields that are currently being indexed.

idrsResponseStatus :: Lens' IndexDocumentsResponse Int #

- | The response status code.