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.CloudSearchDomains.UploadDocuments

Contents

Creating a Request
Request Lenses
Destructuring the Response
Response Lenses

Description

Posts a batch of documents to a search domain for indexing. A document batch is a collection of add and delete operations that represent the documents you want to add, update, or delete from your domain. Batches can be described in either JSON or XML. Each item that you want Amazon CloudSearch to return as a search result (such as a product) is represented as a document. Every document has a unique ID and one or more fields that contain the data that you want to search and return in results. Individual documents cannot contain more than 1 MB of data. The entire batch cannot exceed 5 MB. To get the best possible upload performance, group add and delete operations in batches that are close the 5 MB limit. Submitting a large volume of single-document batches can overload a domain's document service.

The endpoint for submitting UploadDocuments requests is domain-specific. To get the document endpoint for your domain, use the Amazon CloudSearch configuration service DescribeDomains action. A domain's endpoints are also displayed on the domain dashboard in the Amazon CloudSearch console.

For more information about formatting your data for Amazon CloudSearch, see Preparing Your Data in the Amazon CloudSearch Developer Guide . For more information about uploading data for indexing, see Uploading Data in the Amazon CloudSearch Developer Guide .

Creating a Request

uploadDocuments #

Arguments

:: ContentType	`udContentType`
-> HashedBody	`udDocuments`
-> UploadDocuments

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

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

udContentType - The format of the batch you are uploading. Amazon CloudSearch supports two document batch formats: * applicationjson * applicationxml
udDocuments - A batch of documents formatted in JSON or HTML.

data UploadDocuments #

Container for the parameters to the UploadDocuments request.

See: uploadDocuments smart constructor.

Instances

Show UploadDocuments #
Instance details Defined in Network.AWS.CloudSearchDomains.UploadDocuments Methods showsPrec :: Int -> UploadDocuments -> ShowS # show :: UploadDocuments -> String # showList :: [UploadDocuments] -> ShowS #
Generic UploadDocuments #
Instance details Defined in Network.AWS.CloudSearchDomains.UploadDocuments Associated Types type Rep UploadDocuments :: * -> * # Methods from :: UploadDocuments -> Rep UploadDocuments x # to :: Rep UploadDocuments x -> UploadDocuments #
AWSRequest UploadDocuments #
Instance details Defined in Network.AWS.CloudSearchDomains.UploadDocuments Associated Types type Rs UploadDocuments :: * # Methods request :: UploadDocuments -> Request UploadDocuments # response :: (MonadResource m, MonadThrow m) => Logger -> Service -> Proxy UploadDocuments -> ClientResponse -> m (Response UploadDocuments) #
ToBody UploadDocuments #
Instance details Defined in Network.AWS.CloudSearchDomains.UploadDocuments Methods toBody :: UploadDocuments -> RqBody #
ToHeaders UploadDocuments #
Instance details Defined in Network.AWS.CloudSearchDomains.UploadDocuments Methods toHeaders :: UploadDocuments -> [Header] #
ToPath UploadDocuments #
Instance details Defined in Network.AWS.CloudSearchDomains.UploadDocuments Methods toPath :: UploadDocuments -> ByteString #
ToQuery UploadDocuments #
Instance details Defined in Network.AWS.CloudSearchDomains.UploadDocuments Methods toQuery :: UploadDocuments -> QueryString #
type Rep UploadDocuments #
Instance details Defined in Network.AWS.CloudSearchDomains.UploadDocuments type Rep UploadDocuments = D1 (MetaData "UploadDocuments" "Network.AWS.CloudSearchDomains.UploadDocuments" "amazonka-cloudsearch-domains-1.6.0-EftuOi0TT019dFerhYEpx8" False) (C1 (MetaCons "UploadDocuments'" PrefixI True) (S1 (MetaSel (Just "_udContentType") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 ContentType) :*: S1 (MetaSel (Just "_udDocuments") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 HashedBody)))
type Rs UploadDocuments #
Instance details Defined in Network.AWS.CloudSearchDomains.UploadDocuments type Rs UploadDocuments = UploadDocumentsResponse

Request Lenses

udContentType :: Lens' UploadDocuments ContentType #

The format of the batch you are uploading. Amazon CloudSearch supports two document batch formats: * applicationjson * applicationxml

udDocuments :: Lens' UploadDocuments HashedBody #

A batch of documents formatted in JSON or HTML.

Destructuring the Response

uploadDocumentsResponse #

Arguments

:: Int	`udrsResponseStatus`
-> UploadDocumentsResponse

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

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

udrsStatus - The status of an UploadDocumentsRequest .
udrsAdds - The number of documents that were added to the search domain.
udrsWarnings - Any warnings returned by the document service about the documents being uploaded.
udrsDeletes - The number of documents that were deleted from the search domain.
udrsResponseStatus - -- | The response status code.

data UploadDocumentsResponse #

Contains the response to an UploadDocuments request.

See: uploadDocumentsResponse smart constructor.

Instances

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

Response Lenses

udrsStatus :: Lens' UploadDocumentsResponse (Maybe Text) #

The status of an UploadDocumentsRequest .

udrsAdds :: Lens' UploadDocumentsResponse (Maybe Integer) #

The number of documents that were added to the search domain.

udrsWarnings :: Lens' UploadDocumentsResponse [DocumentServiceWarning] #

Any warnings returned by the document service about the documents being uploaded.

udrsDeletes :: Lens' UploadDocumentsResponse (Maybe Integer) #

The number of documents that were deleted from the search domain.

udrsResponseStatus :: Lens' UploadDocumentsResponse Int #

- | The response status code.