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 |
- cloudSearchDomains :: Service
- _DocumentServiceException :: AsError a => Getting (First ServiceError) a ServiceError
- _SearchException :: AsError a => Getting (First ServiceError) a ServiceError
- data ContentType
- data QueryParser
- = Dismax
- | Lucene
- | Simple
- | Structured
- data Bucket
- bucket :: Bucket
- bValue :: Lens' Bucket (Maybe Text)
- bCount :: Lens' Bucket (Maybe Integer)
- data BucketInfo
- bucketInfo :: BucketInfo
- biBuckets :: Lens' BucketInfo [Bucket]
- data DocumentServiceWarning
- documentServiceWarning :: DocumentServiceWarning
- dswMessage :: Lens' DocumentServiceWarning (Maybe Text)
- data FieldStats
- fieldStats :: FieldStats
- fsMax :: Lens' FieldStats (Maybe Text)
- fsMean :: Lens' FieldStats (Maybe Text)
- fsCount :: Lens' FieldStats (Maybe Integer)
- fsMissing :: Lens' FieldStats (Maybe Integer)
- fsStddev :: Lens' FieldStats (Maybe Double)
- fsMin :: Lens' FieldStats (Maybe Text)
- fsSumOfSquares :: Lens' FieldStats (Maybe Double)
- fsSum :: Lens' FieldStats (Maybe Double)
- data Hit
- hit :: Hit
- hitExprs :: Lens' Hit (HashMap Text Text)
- hitId :: Lens' Hit (Maybe Text)
- hitHighlights :: Lens' Hit (HashMap Text Text)
- hitFields :: Lens' Hit (HashMap Text [Text])
- data Hits
- hits :: Hits
- hCursor :: Lens' Hits (Maybe Text)
- hHit :: Lens' Hits [Hit]
- hStart :: Lens' Hits (Maybe Integer)
- hFound :: Lens' Hits (Maybe Integer)
- data SearchStatus
- searchStatus :: SearchStatus
- sRid :: Lens' SearchStatus (Maybe Text)
- sTimems :: Lens' SearchStatus (Maybe Integer)
- data SuggestModel
- suggestModel :: SuggestModel
- smFound :: Lens' SuggestModel (Maybe Integer)
- smSuggestions :: Lens' SuggestModel [SuggestionMatch]
- smQuery :: Lens' SuggestModel (Maybe Text)
- data SuggestStatus
- suggestStatus :: SuggestStatus
- ssRid :: Lens' SuggestStatus (Maybe Text)
- ssTimems :: Lens' SuggestStatus (Maybe Integer)
- data SuggestionMatch
- suggestionMatch :: SuggestionMatch
- smSuggestion :: Lens' SuggestionMatch (Maybe Text)
- smScore :: Lens' SuggestionMatch (Maybe Integer)
- smId :: Lens' SuggestionMatch (Maybe Text)
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 #
QueryParser
data QueryParser Source #
Bucket
A container for facet information.
See: bucket
smart constructor.
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
- 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
- The description for a warning returned by the document service.
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
- The maximum value found in the specified field in the result set. If the field is numeric (int
,int-array
,double
, ordouble-array
),max
is the string representation of a double-precision 64-bit floating point value. If the field isdate
ordate-array
,max
is the string representation of a date with the format specified in IETF RFC3339 : yyyy-mm-ddTHH:mm:ss.SSSZ.fsMean
- The average of the values found in the specified field in the result set. If the field is numeric (int
,int-array
,double
, ordouble-array
),mean
is the string representation of a double-precision 64-bit floating point value. If the field isdate
ordate-array
,mean
is the string representation of a date with the format specified in IETF RFC3339 : yyyy-mm-ddTHH:mm:ss.SSSZ.fsCount
- The number of documents that contain a value in the specified field in the result set.fsMissing
- The number of documents that do not contain a value in the specified field in the result set.fsStddev
- The standard deviation of the values in the specified field in the result set.fsMin
- The minimum value found in the specified field in the result set. If the field is numeric (int
,int-array
,double
, ordouble-array
),min
is the string representation of a double-precision 64-bit floating point value. If the field isdate
ordate-array
,min
is the string representation of a date with the format specified in IETF RFC3339 : yyyy-mm-ddTHH:mm:ss.SSSZ.fsSumOfSquares
- The sum of all field values in the result set squared.fsSum
- The sum of the field values across the documents in the result set.null
for date fields.
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
Information about a document that matches the search request.
See: hit
smart constructor.
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
- The expressions returned from a document that matches the search request.hitId
- The document ID of a document that matches the search request.hitHighlights
- The highlights returned from a document that matches the search request.hitFields
- The fields returned from a document that matches the search request.
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
The collection of documents that match the search request.
See: hits
smart constructor.
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
- 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
- A document that matches the search request.hStart
- The index of the first matching document.hFound
- The total number of documents that match the search request.
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.
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:
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
- The number of documents that were found to match the query string.smSuggestions
- The documents that match the query string.smQuery
- The query string specified in the suggest request.
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:
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
- The string that matches the query string specified in theSuggestRequest
.smScore
- The relevance score of a suggested match.smId
- The document ID of the suggested document.
smSuggestion :: Lens' SuggestionMatch (Maybe Text) Source #
The string that matches the query string specified in the SuggestRequest
.