Copyright	(c) 2013-2016 Brendan Hay
License	Mozilla Public License, v. 2.0.
Maintainer	Brendan Hay <brendan.g.hay@gmail.com>
Stability	auto-generated
Portability	non-portable (GHC extensions)
Safe Haskell	None
Language	Haskell2010

Network.AWS.CloudSearchDomains.Types

Contents

Service Configuration
Errors
ContentType
QueryParser
Bucket
BucketInfo
DocumentServiceWarning
FieldStats
Hit
Hits
SearchStatus
SuggestModel
SuggestStatus
SuggestionMatch

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

QueryParser

Bucket

data Bucket Source

A container for facet information.

See: bucket smart constructor.

Instances

Eq Bucket Source
Data Bucket Source
Read Bucket Source
Show Bucket Source
Generic Bucket Source
FromJSON Bucket Source
Hashable Bucket Source
type Rep Bucket Source

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
bCount

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.

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

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.

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

dswMessage :: Lens' DocumentServiceWarning (Maybe Text) Source

The description for a warning returned by the document service.

FieldStats

data FieldStats Source

The statistics for a field calculated in the request.

See: fieldStats smart constructor.

fieldStats :: FieldStats Source

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

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

fsMax :: Lens' FieldStats (Maybe Text) Source

The maximum value found in the specified field in the result set.

If the field is numeric (int, 'int-array', double, or 'double-array'), max is the string representation of a double-precision 64-bit floating point value. If the field is date or 'date-array', max is the string representation of a date with the format specified in IETF RFC3339: yyyy-mm-ddTHH:mm:ss.SSSZ.

fsMean :: Lens' FieldStats (Maybe Text) Source

The average of the values found in the specified field in the result set.

If the field is numeric (int, 'int-array', double, or 'double-array'), mean is the string representation of a double-precision 64-bit floating point value. If the field is date or 'date-array', mean is the string representation of a date with the format specified in IETF RFC3339: yyyy-mm-ddTHH:mm:ss.SSSZ.

fsCount :: Lens' FieldStats (Maybe Integer) Source

The number of documents that contain a value in the specified field in the result set.

fsMissing :: Lens' FieldStats (Maybe Integer) Source

The number of documents that do not contain a value in the specified field in the result set.

fsStddev :: Lens' FieldStats (Maybe Double) Source

The standard deviation of the values in the specified field in the result set.

fsMin :: Lens' FieldStats (Maybe Text) Source

The minimum value found in the specified field in the result set.

If the field is numeric (int, 'int-array', double, or 'double-array'), min is the string representation of a double-precision 64-bit floating point value. If the field is date or 'date-array', min is the string representation of a date with the format specified in IETF RFC3339: yyyy-mm-ddTHH:mm:ss.SSSZ.

fsSumOfSquares :: Lens' FieldStats (Maybe Double) Source

The sum of all field values in the result set squared.

fsSum :: Lens' FieldStats (Maybe Double) Source

The sum of the field values across the documents in the result set. null for date fields.

Hit

data Hit Source

Information about a document that matches the search request.

See: hit smart constructor.

Instances

Eq Hit Source
Data Hit Source
Read Hit Source
Show Hit Source
Generic Hit Source
FromJSON Hit Source
Hashable Hit Source
type Rep Hit Source

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

Eq Hits Source
Data Hits Source
Read Hits Source
Show Hits Source
Generic Hits Source
FromJSON Hits Source
Hashable Hits Source
type Rep Hits Source

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.

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:

sRid
sTimems

sRid :: Lens' SearchStatus (Maybe Text) Source

The encrypted resource ID for the request.

sTimems :: 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.

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.

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:

ssRid
ssTimems

ssRid :: Lens' SuggestStatus (Maybe Text) Source

The encrypted resource ID for the request.

ssTimems :: 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.

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.

Bounded ContentType Source
Enum ContentType Source
Eq ContentType Source
Data ContentType Source
Ord ContentType Source
Read ContentType Source
Show ContentType Source
Generic ContentType Source
ToJSON ContentType Source
Hashable ContentType Source
ToHeader ContentType Source
ToQuery ContentType Source
ToByteString ContentType Source
FromText ContentType Source
ToText ContentType Source
type Rep ContentType Source

Dismax
Lucene
Simple
Structured

Bounded QueryParser Source
Enum QueryParser Source
Eq QueryParser Source
Data QueryParser Source
Ord QueryParser Source
Read QueryParser Source
Show QueryParser Source
Generic QueryParser Source
ToJSON QueryParser Source
Hashable QueryParser Source
ToHeader QueryParser Source
ToQuery QueryParser Source
ToByteString QueryParser Source
FromText QueryParser Source
ToText QueryParser Source
type Rep QueryParser Source

Eq BucketInfo Source
Data BucketInfo Source
Read BucketInfo Source
Show BucketInfo Source
Generic BucketInfo Source
FromJSON BucketInfo Source
Hashable BucketInfo Source
type Rep BucketInfo Source

Eq DocumentServiceWarning Source
Data DocumentServiceWarning Source
Read DocumentServiceWarning Source
Show DocumentServiceWarning Source
Generic DocumentServiceWarning Source
FromJSON DocumentServiceWarning Source
Hashable DocumentServiceWarning Source
type Rep DocumentServiceWarning Source

Eq FieldStats Source
Data FieldStats Source
Read FieldStats Source
Show FieldStats Source
Generic FieldStats Source
FromJSON FieldStats Source
Hashable FieldStats Source
type Rep FieldStats Source

Eq SearchStatus Source
Data SearchStatus Source
Read SearchStatus Source
Show SearchStatus Source
Generic SearchStatus Source
FromJSON SearchStatus Source
Hashable SearchStatus Source
type Rep SearchStatus Source

Eq SuggestModel Source
Data SuggestModel Source
Read SuggestModel Source
Show SuggestModel Source
Generic SuggestModel Source
FromJSON SuggestModel Source
Hashable SuggestModel Source
type Rep SuggestModel Source

Eq SuggestStatus Source
Data SuggestStatus Source
Read SuggestStatus Source
Show SuggestStatus Source
Generic SuggestStatus Source
FromJSON SuggestStatus Source
Hashable SuggestStatus Source
type Rep SuggestStatus Source

Eq SuggestionMatch Source
Data SuggestionMatch Source
Read SuggestionMatch Source
Show SuggestionMatch Source
Generic SuggestionMatch Source
FromJSON SuggestionMatch Source
Hashable SuggestionMatch Source
type Rep SuggestionMatch Source