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 |
Synopsis
- 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 #
Instances
QueryParser
data QueryParser Source #
Instances
Bucket
A container for facet information.
See: bucket
smart constructor.
Instances
Eq Bucket Source # | |
Data Bucket Source # | |
Defined in Network.AWS.CloudSearchDomains.Types.Product gfoldl :: (forall d b. Data d => c (d -> b) -> d -> c b) -> (forall g. g -> c g) -> Bucket -> c Bucket # gunfold :: (forall b r. Data b => c (b -> r) -> c r) -> (forall r. r -> c r) -> Constr -> c Bucket # toConstr :: Bucket -> Constr # dataTypeOf :: Bucket -> DataType # dataCast1 :: Typeable t => (forall d. Data d => c (t d)) -> Maybe (c Bucket) # dataCast2 :: Typeable t => (forall d e. (Data d, Data e) => c (t d e)) -> Maybe (c Bucket) # gmapT :: (forall b. Data b => b -> b) -> Bucket -> Bucket # gmapQl :: (r -> r' -> r) -> r -> (forall d. Data d => d -> r') -> Bucket -> r # gmapQr :: (r' -> r -> r) -> r -> (forall d. Data d => d -> r') -> Bucket -> r # gmapQ :: (forall d. Data d => d -> u) -> Bucket -> [u] # gmapQi :: Int -> (forall d. Data d => d -> u) -> Bucket -> u # gmapM :: Monad m => (forall d. Data d => d -> m d) -> Bucket -> m Bucket # gmapMp :: MonadPlus m => (forall d. Data d => d -> m d) -> Bucket -> m Bucket # gmapMo :: MonadPlus m => (forall d. Data d => d -> m d) -> Bucket -> m Bucket # | |
Read Bucket Source # | |
Show Bucket Source # | |
Generic Bucket Source # | |
Hashable Bucket Source # | |
Defined in Network.AWS.CloudSearchDomains.Types.Product | |
FromJSON Bucket Source # | |
NFData Bucket Source # | |
Defined in Network.AWS.CloudSearchDomains.Types.Product | |
type Rep Bucket Source # | |
Defined in Network.AWS.CloudSearchDomains.Types.Product type Rep Bucket = D1 (MetaData "Bucket" "Network.AWS.CloudSearchDomains.Types.Product" "amazonka-cloudsearch-domains-1.6.1-3MDoOGTk8dg5jf7Q9NEUiM" False) (C1 (MetaCons "Bucket'" PrefixI True) (S1 (MetaSel (Just "_bValue") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 (Maybe Text)) :*: S1 (MetaSel (Just "_bCount") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 (Maybe Integer)))) |
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
- 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
- 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.
Instances
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.
Instances
Eq Hit Source # | |
Data Hit Source # | |
Defined in Network.AWS.CloudSearchDomains.Types.Product gfoldl :: (forall d b. Data d => c (d -> b) -> d -> c b) -> (forall g. g -> c g) -> Hit -> c Hit # gunfold :: (forall b r. Data b => c (b -> r) -> c r) -> (forall r. r -> c r) -> Constr -> c Hit # dataTypeOf :: Hit -> DataType # dataCast1 :: Typeable t => (forall d. Data d => c (t d)) -> Maybe (c Hit) # dataCast2 :: Typeable t => (forall d e. (Data d, Data e) => c (t d e)) -> Maybe (c Hit) # gmapT :: (forall b. Data b => b -> b) -> Hit -> Hit # gmapQl :: (r -> r' -> r) -> r -> (forall d. Data d => d -> r') -> Hit -> r # gmapQr :: (r' -> r -> r) -> r -> (forall d. Data d => d -> r') -> Hit -> r # gmapQ :: (forall d. Data d => d -> u) -> Hit -> [u] # gmapQi :: Int -> (forall d. Data d => d -> u) -> Hit -> u # gmapM :: Monad m => (forall d. Data d => d -> m d) -> Hit -> m Hit # gmapMp :: MonadPlus m => (forall d. Data d => d -> m d) -> Hit -> m Hit # gmapMo :: MonadPlus m => (forall d. Data d => d -> m d) -> Hit -> m Hit # | |
Read Hit Source # | |
Show Hit Source # | |
Generic Hit Source # | |
Hashable Hit Source # | |
Defined in Network.AWS.CloudSearchDomains.Types.Product | |
FromJSON Hit Source # | |
NFData Hit Source # | |
Defined in Network.AWS.CloudSearchDomains.Types.Product | |
type Rep Hit Source # | |
Defined in Network.AWS.CloudSearchDomains.Types.Product type Rep Hit = D1 (MetaData "Hit" "Network.AWS.CloudSearchDomains.Types.Product" "amazonka-cloudsearch-domains-1.6.1-3MDoOGTk8dg5jf7Q9NEUiM" False) (C1 (MetaCons "Hit'" PrefixI True) ((S1 (MetaSel (Just "_hitExprs") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 (Maybe (Map Text Text))) :*: S1 (MetaSel (Just "_hitId") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 (Maybe Text))) :*: (S1 (MetaSel (Just "_hitHighlights") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 (Maybe (Map Text Text))) :*: S1 (MetaSel (Just "_hitFields") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 (Maybe (Map Text [Text])))))) |
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.
Instances
Eq Hits Source # | |
Data Hits Source # | |
Defined in Network.AWS.CloudSearchDomains.Types.Product gfoldl :: (forall d b. Data d => c (d -> b) -> d -> c b) -> (forall g. g -> c g) -> Hits -> c Hits # gunfold :: (forall b r. Data b => c (b -> r) -> c r) -> (forall r. r -> c r) -> Constr -> c Hits # dataTypeOf :: Hits -> DataType # dataCast1 :: Typeable t => (forall d. Data d => c (t d)) -> Maybe (c Hits) # dataCast2 :: Typeable t => (forall d e. (Data d, Data e) => c (t d e)) -> Maybe (c Hits) # gmapT :: (forall b. Data b => b -> b) -> Hits -> Hits # gmapQl :: (r -> r' -> r) -> r -> (forall d. Data d => d -> r') -> Hits -> r # gmapQr :: (r' -> r -> r) -> r -> (forall d. Data d => d -> r') -> Hits -> r # gmapQ :: (forall d. Data d => d -> u) -> Hits -> [u] # gmapQi :: Int -> (forall d. Data d => d -> u) -> Hits -> u # gmapM :: Monad m => (forall d. Data d => d -> m d) -> Hits -> m Hits # gmapMp :: MonadPlus m => (forall d. Data d => d -> m d) -> Hits -> m Hits # gmapMo :: MonadPlus m => (forall d. Data d => d -> m d) -> Hits -> m Hits # | |
Read Hits Source # | |
Show Hits Source # | |
Generic Hits Source # | |
Hashable Hits Source # | |
Defined in Network.AWS.CloudSearchDomains.Types.Product | |
FromJSON Hits Source # | |
NFData Hits Source # | |
Defined in Network.AWS.CloudSearchDomains.Types.Product | |
type Rep Hits Source # | |
Defined in Network.AWS.CloudSearchDomains.Types.Product type Rep Hits = D1 (MetaData "Hits" "Network.AWS.CloudSearchDomains.Types.Product" "amazonka-cloudsearch-domains-1.6.1-3MDoOGTk8dg5jf7Q9NEUiM" False) (C1 (MetaCons "Hits'" PrefixI True) ((S1 (MetaSel (Just "_hCursor") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 (Maybe Text)) :*: S1 (MetaSel (Just "_hHit") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 (Maybe [Hit]))) :*: (S1 (MetaSel (Just "_hStart") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 (Maybe Integer)) :*: S1 (MetaSel (Just "_hFound") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 (Maybe Integer))))) |
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.
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:
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.
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
- 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.
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:
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.
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
- 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
.