Copyright | (c) 2013-2021 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 |
Synopsis
- defaultService :: Service
- _DocumentServiceException :: AsError a => Getting (First ServiceError) a ServiceError
- _SearchException :: AsError a => Getting (First ServiceError) a ServiceError
- newtype ContentType where
- ContentType' { }
- pattern ContentType_Application_json :: ContentType
- pattern ContentType_Application_xml :: ContentType
- newtype QueryParser where
- QueryParser' { }
- pattern QueryParser_Dismax :: QueryParser
- pattern QueryParser_Lucene :: QueryParser
- pattern QueryParser_Simple :: QueryParser
- pattern QueryParser_Structured :: QueryParser
- data Bucket = Bucket' {}
- newBucket :: Bucket
- bucket_value :: Lens' Bucket (Maybe Text)
- bucket_count :: Lens' Bucket (Maybe Integer)
- data BucketInfo = BucketInfo' {}
- newBucketInfo :: BucketInfo
- bucketInfo_buckets :: Lens' BucketInfo (Maybe [Bucket])
- data DocumentServiceWarning = DocumentServiceWarning' {}
- newDocumentServiceWarning :: DocumentServiceWarning
- documentServiceWarning_message :: Lens' DocumentServiceWarning (Maybe Text)
- data FieldStats = FieldStats' {}
- newFieldStats :: FieldStats
- fieldStats_max :: Lens' FieldStats (Maybe Text)
- fieldStats_mean :: Lens' FieldStats (Maybe Text)
- fieldStats_count :: Lens' FieldStats (Maybe Integer)
- fieldStats_missing :: Lens' FieldStats (Maybe Integer)
- fieldStats_stddev :: Lens' FieldStats (Maybe Double)
- fieldStats_min :: Lens' FieldStats (Maybe Text)
- fieldStats_sumOfSquares :: Lens' FieldStats (Maybe Double)
- fieldStats_sum :: Lens' FieldStats (Maybe Double)
- data Hit = Hit' {}
- newHit :: Hit
- hit_exprs :: Lens' Hit (Maybe (HashMap Text Text))
- hit_id :: Lens' Hit (Maybe Text)
- hit_highlights :: Lens' Hit (Maybe (HashMap Text Text))
- hit_fields :: Lens' Hit (Maybe (HashMap Text [Text]))
- data Hits = Hits' {}
- newHits :: Hits
- hits_cursor :: Lens' Hits (Maybe Text)
- hits_hit :: Lens' Hits (Maybe [Hit])
- hits_start :: Lens' Hits (Maybe Integer)
- hits_found :: Lens' Hits (Maybe Integer)
- data SearchStatus = SearchStatus' {}
- newSearchStatus :: SearchStatus
- searchStatus_rid :: Lens' SearchStatus (Maybe Text)
- searchStatus_timems :: Lens' SearchStatus (Maybe Integer)
- data SuggestModel = SuggestModel' {
- found :: Maybe Integer
- suggestions :: Maybe [SuggestionMatch]
- query :: Maybe Text
- newSuggestModel :: SuggestModel
- suggestModel_found :: Lens' SuggestModel (Maybe Integer)
- suggestModel_suggestions :: Lens' SuggestModel (Maybe [SuggestionMatch])
- suggestModel_query :: Lens' SuggestModel (Maybe Text)
- data SuggestStatus = SuggestStatus' {}
- newSuggestStatus :: SuggestStatus
- suggestStatus_rid :: Lens' SuggestStatus (Maybe Text)
- suggestStatus_timems :: Lens' SuggestStatus (Maybe Integer)
- data SuggestionMatch = SuggestionMatch' {}
- newSuggestionMatch :: SuggestionMatch
- suggestionMatch_suggestion :: Lens' SuggestionMatch (Maybe Text)
- suggestionMatch_score :: Lens' SuggestionMatch (Maybe Integer)
- suggestionMatch_id :: Lens' SuggestionMatch (Maybe Text)
Service Configuration
defaultService :: 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
newtype ContentType Source #
pattern ContentType_Application_json :: ContentType | |
pattern ContentType_Application_xml :: ContentType |
Instances
QueryParser
newtype QueryParser Source #
pattern QueryParser_Dismax :: QueryParser | |
pattern QueryParser_Lucene :: QueryParser | |
pattern QueryParser_Simple :: QueryParser | |
pattern QueryParser_Structured :: QueryParser |
Instances
Bucket
A container for facet information.
See: newBucket
smart constructor.
Instances
Eq Bucket Source # | |
Read Bucket Source # | |
Show Bucket Source # | |
Generic Bucket Source # | |
NFData Bucket Source # | |
Defined in Amazonka.CloudSearchDomains.Types.Bucket | |
Hashable Bucket Source # | |
Defined in Amazonka.CloudSearchDomains.Types.Bucket | |
FromJSON Bucket Source # | |
type Rep Bucket Source # | |
Defined in Amazonka.CloudSearchDomains.Types.Bucket type Rep Bucket = D1 ('MetaData "Bucket" "Amazonka.CloudSearchDomains.Types.Bucket" "libZSservicesZSamazonka-cloudsearch-domainsZSamazonka-cloudsearch-domains" 'False) (C1 ('MetaCons "Bucket'" 'PrefixI 'True) (S1 ('MetaSel ('Just "value") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :*: S1 ('MetaSel ('Just "count") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Integer)))) |
Create a value of Bucket
with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:value:Bucket'
, bucket_value
- The facet value being counted.
$sel:count:Bucket'
, bucket_count
- The number of hits that contain the facet value in the specified facet
field.
bucket_count :: 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: newBucketInfo
smart constructor.
Instances
newBucketInfo :: BucketInfo Source #
Create a value of BucketInfo
with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:buckets:BucketInfo'
, bucketInfo_buckets
- A list of the calculated facet values and counts.
bucketInfo_buckets :: Lens' BucketInfo (Maybe [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: newDocumentServiceWarning
smart constructor.
Instances
newDocumentServiceWarning :: DocumentServiceWarning Source #
Create a value of DocumentServiceWarning
with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:message:DocumentServiceWarning'
, documentServiceWarning_message
- The description for a warning returned by the document service.
documentServiceWarning_message :: 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: newFieldStats
smart constructor.
FieldStats' | |
|
Instances
newFieldStats :: FieldStats Source #
Create a value of FieldStats
with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:max:FieldStats'
, fieldStats_max
- 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.
$sel:mean:FieldStats'
, fieldStats_mean
- 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.
$sel:count:FieldStats'
, fieldStats_count
- The number of documents that contain a value in the specified field in
the result set.
$sel:missing:FieldStats'
, fieldStats_missing
- The number of documents that do not contain a value in the specified
field in the result set.
$sel:stddev:FieldStats'
, fieldStats_stddev
- The standard deviation of the values in the specified field in the
result set.
$sel:min:FieldStats'
, fieldStats_min
- 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.
$sel:sumOfSquares:FieldStats'
, fieldStats_sumOfSquares
- The sum of all field values in the result set squared.
$sel:sum:FieldStats'
, fieldStats_sum
- The sum of the field values across the documents in the result set.
null
for date fields.
fieldStats_max :: 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.
fieldStats_mean :: 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.
fieldStats_count :: Lens' FieldStats (Maybe Integer) Source #
The number of documents that contain a value in the specified field in the result set.
fieldStats_missing :: Lens' FieldStats (Maybe Integer) Source #
The number of documents that do not contain a value in the specified field in the result set.
fieldStats_stddev :: Lens' FieldStats (Maybe Double) Source #
The standard deviation of the values in the specified field in the result set.
fieldStats_min :: 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.
fieldStats_sumOfSquares :: Lens' FieldStats (Maybe Double) Source #
The sum of all field values in the result set squared.
fieldStats_sum :: 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: newHit
smart constructor.
Hit' | |
|
Instances
Eq Hit Source # | |
Read Hit Source # | |
Show Hit Source # | |
Generic Hit Source # | |
NFData Hit Source # | |
Defined in Amazonka.CloudSearchDomains.Types.Hit | |
Hashable Hit Source # | |
Defined in Amazonka.CloudSearchDomains.Types.Hit | |
FromJSON Hit Source # | |
type Rep Hit Source # | |
Defined in Amazonka.CloudSearchDomains.Types.Hit type Rep Hit = D1 ('MetaData "Hit" "Amazonka.CloudSearchDomains.Types.Hit" "libZSservicesZSamazonka-cloudsearch-domainsZSamazonka-cloudsearch-domains" 'False) (C1 ('MetaCons "Hit'" 'PrefixI 'True) ((S1 ('MetaSel ('Just "exprs") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe (HashMap Text Text))) :*: S1 ('MetaSel ('Just "id") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text))) :*: (S1 ('MetaSel ('Just "highlights") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe (HashMap Text Text))) :*: S1 ('MetaSel ('Just "fields") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe (HashMap Text [Text])))))) |
Create a value of Hit
with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:exprs:Hit'
, hit_exprs
- The expressions returned from a document that matches the search
request.
$sel:id:Hit'
, hit_id
- The document ID of a document that matches the search request.
$sel:highlights:Hit'
, hit_highlights
- The highlights returned from a document that matches the search request.
$sel:fields:Hit'
, hit_fields
- The fields returned from a document that matches the search request.
hit_exprs :: Lens' Hit (Maybe (HashMap Text Text)) Source #
The expressions returned from a document that matches the search request.
hit_id :: Lens' Hit (Maybe Text) Source #
The document ID of a document that matches the search request.
hit_highlights :: Lens' Hit (Maybe (HashMap Text Text)) Source #
The highlights returned from a document that matches the search request.
hit_fields :: Lens' Hit (Maybe (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: newHits
smart constructor.
Hits' | |
|
Instances
Eq Hits Source # | |
Read Hits Source # | |
Show Hits Source # | |
Generic Hits Source # | |
NFData Hits Source # | |
Defined in Amazonka.CloudSearchDomains.Types.Hits | |
Hashable Hits Source # | |
Defined in Amazonka.CloudSearchDomains.Types.Hits | |
FromJSON Hits Source # | |
type Rep Hits Source # | |
Defined in Amazonka.CloudSearchDomains.Types.Hits type Rep Hits = D1 ('MetaData "Hits" "Amazonka.CloudSearchDomains.Types.Hits" "libZSservicesZSamazonka-cloudsearch-domainsZSamazonka-cloudsearch-domains" 'False) (C1 ('MetaCons "Hits'" 'PrefixI 'True) ((S1 ('MetaSel ('Just "cursor") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :*: S1 ('MetaSel ('Just "hit") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe [Hit]))) :*: (S1 ('MetaSel ('Just "start") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Integer)) :*: S1 ('MetaSel ('Just "found") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Integer))))) |
Create a value of Hits
with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:cursor:Hits'
, hits_cursor
- A cursor that can be used to retrieve the next set of matching documents
when you want to page through a large result set.
$sel:hit:Hits'
, hits_hit
- A document that matches the search request.
$sel:start:Hits'
, hits_start
- The index of the first matching document.
$sel:found:Hits'
, hits_found
- The total number of documents that match the search request.
hits_cursor :: 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.
hits_found :: 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: newSearchStatus
smart constructor.
Instances
newSearchStatus :: SearchStatus Source #
Create a value of SearchStatus
with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:rid:SearchStatus'
, searchStatus_rid
- The encrypted resource ID for the request.
$sel:timems:SearchStatus'
, searchStatus_timems
- How long it took to process the request, in milliseconds.
searchStatus_rid :: Lens' SearchStatus (Maybe Text) Source #
The encrypted resource ID for the request.
searchStatus_timems :: 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: newSuggestModel
smart constructor.
SuggestModel' | |
|
Instances
newSuggestModel :: SuggestModel Source #
Create a value of SuggestModel
with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:found:SuggestModel'
, suggestModel_found
- The number of documents that were found to match the query string.
$sel:suggestions:SuggestModel'
, suggestModel_suggestions
- The documents that match the query string.
$sel:query:SuggestModel'
, suggestModel_query
- The query string specified in the suggest request.
suggestModel_found :: Lens' SuggestModel (Maybe Integer) Source #
The number of documents that were found to match the query string.
suggestModel_suggestions :: Lens' SuggestModel (Maybe [SuggestionMatch]) Source #
The documents that match the query string.
suggestModel_query :: 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: newSuggestStatus
smart constructor.
Instances
newSuggestStatus :: SuggestStatus Source #
Create a value of SuggestStatus
with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:rid:SuggestStatus'
, suggestStatus_rid
- The encrypted resource ID for the request.
$sel:timems:SuggestStatus'
, suggestStatus_timems
- How long it took to process the request, in milliseconds.
suggestStatus_rid :: Lens' SuggestStatus (Maybe Text) Source #
The encrypted resource ID for the request.
suggestStatus_timems :: 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: newSuggestionMatch
smart constructor.
Instances
newSuggestionMatch :: SuggestionMatch Source #
Create a value of SuggestionMatch
with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:suggestion:SuggestionMatch'
, suggestionMatch_suggestion
- The string that matches the query string specified in the
SuggestRequest
.
$sel:score:SuggestionMatch'
, suggestionMatch_score
- The relevance score of a suggested match.
$sel:id:SuggestionMatch'
, suggestionMatch_id
- The document ID of the suggested document.
suggestionMatch_suggestion :: Lens' SuggestionMatch (Maybe Text) Source #
The string that matches the query string specified in the
SuggestRequest
.
suggestionMatch_score :: Lens' SuggestionMatch (Maybe Integer) Source #
The relevance score of a suggested match.
suggestionMatch_id :: Lens' SuggestionMatch (Maybe Text) Source #
The document ID of the suggested document.