amazonka-cloudsearch-domains-1.2.0.1: Amazon CloudSearch Domain SDK.

Copyright(c) 2013-2015 Brendan Hay
LicenseMozilla Public License, v. 2.0.
MaintainerBrendan Hay <brendan.g.hay@gmail.com>
Stabilityauto-generated
Portabilitynon-portable (GHC extensions)
Safe HaskellNone
LanguageHaskell2010

Network.AWS.CloudSearchDomains.Types

Contents

Description

 

Synopsis

Service Configuration

cloudSearchDomains :: Service Source

API version '2013-01-01' of the Amazon CloudSearch Domain SDK configuration.

Errors

_DocumentServiceException :: AsError a => Getting (First ServiceError) a ServiceError Source

Information about any problems encountered while processing an upload request.

_SearchException :: AsError a => Getting (First ServiceError) a ServiceError Source

Information about any problems encountered while processing a search request.

ContentType

data ContentType Source

Constructors

ApplicationJSON 
ApplicationXML 

Instances

QueryParser

data QueryParser Source

Constructors

Dismax 
Lucene 
Simple 
Structured 

Instances

Bucket

data Bucket Source

A container for facet information.

See: bucket smart constructor.

Instances

bucket :: Bucket Source

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

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

bValue :: Lens' Bucket (Maybe Text) Source

The facet value being counted.

bCount :: Lens' Bucket (Maybe Integer) Source

The number of hits that contain the facet value in the specified facet field.

BucketInfo

data BucketInfo Source

A container for the calculated facet values and counts.

See: bucketInfo smart constructor.

Instances

bucketInfo :: BucketInfo Source

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

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

biBuckets :: Lens' BucketInfo [Bucket] Source

A list of the calculated facet values and counts.

DocumentServiceWarning

data DocumentServiceWarning Source

A warning returned by the document service when an issue is discovered while processing an upload request.

See: documentServiceWarning smart constructor.

Instances

documentServiceWarning :: DocumentServiceWarning Source

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

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

dswMessage :: Lens' DocumentServiceWarning (Maybe Text) Source

The description for a warning returned by the document service.

Hit

data Hit Source

Information about a document that matches the search request.

See: hit smart constructor.

Instances

hit :: Hit Source

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

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

hitExprs :: Lens' Hit (HashMap Text Text) Source

The expressions returned from a document that matches the search request.

hitId :: Lens' Hit (Maybe Text) Source

The document ID of a document that matches the search request.

hitHighlights :: Lens' Hit (HashMap Text Text) Source

The highlights returned from a document that matches the search request.

hitFields :: Lens' Hit (HashMap Text [Text]) Source

The fields returned from a document that matches the search request.

Hits

data Hits Source

The collection of documents that match the search request.

See: hits smart constructor.

Instances

hits :: Hits Source

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

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

hCursor :: Lens' Hits (Maybe Text) Source

A cursor that can be used to retrieve the next set of matching documents when you want to page through a large result set.

hHit :: Lens' Hits [Hit] Source

A document that matches the search request.

hStart :: Lens' Hits (Maybe Integer) Source

The index of the first matching document.

hFound :: Lens' Hits (Maybe Integer) Source

The total number of documents that match the search request.

SearchStatus

data SearchStatus Source

Contains the resource id (rid) and the time it took to process the request (timems).

See: searchStatus smart constructor.

Instances

searchStatus :: SearchStatus Source

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

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

ssRid :: Lens' SearchStatus (Maybe Text) Source

The encrypted resource ID for the request.

ssTimems :: Lens' SearchStatus (Maybe Integer) Source

How long it took to process the request, in milliseconds.

SuggestModel

data SuggestModel Source

Container for the suggestion information returned in a SuggestResponse.

See: suggestModel smart constructor.

Instances

suggestModel :: SuggestModel Source

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

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

smFound :: Lens' SuggestModel (Maybe Integer) Source

The number of documents that were found to match the query string.

smSuggestions :: Lens' SuggestModel [SuggestionMatch] Source

The documents that match the query string.

smQuery :: Lens' SuggestModel (Maybe Text) Source

The query string specified in the suggest request.

SuggestStatus

data SuggestStatus Source

Contains the resource id (rid) and the time it took to process the request (timems).

See: suggestStatus smart constructor.

Instances

suggestStatus :: SuggestStatus Source

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

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

sRid :: Lens' SuggestStatus (Maybe Text) Source

The encrypted resource ID for the request.

sTimems :: Lens' SuggestStatus (Maybe Integer) Source

How long it took to process the request, in milliseconds.

SuggestionMatch

data SuggestionMatch Source

An autocomplete suggestion that matches the query string specified in a SuggestRequest.

See: suggestionMatch smart constructor.

Instances

suggestionMatch :: SuggestionMatch Source

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

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

smSuggestion :: Lens' SuggestionMatch (Maybe Text) Source

The string that matches the query string specified in the SuggestRequest.

smScore :: Lens' SuggestionMatch (Maybe Integer) Source

The relevance score of a suggested match.

smId :: Lens' SuggestionMatch (Maybe Text) Source

The document ID of the suggested document.