Copyright	(c) 2013-2023 Brendan Hay
License	Mozilla Public License, v. 2.0.
Maintainer	Brendan Hay
Stability	auto-generated
Portability	non-portable (GHC extensions)
Safe Haskell	Safe-Inferred
Language	Haskell2010

Amazonka.CloudSearchDomains.Types

Contents

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

Description

Synopsis

defaultService :: Service
_DocumentServiceException :: AsError a => Fold a ServiceError
_SearchException :: AsError a => Fold a ServiceError
newtype ContentType where
- ContentType' {
  - fromContentType :: Text
  }
- pattern ContentType_Application_json :: ContentType
- pattern ContentType_Application_xml :: ContentType
newtype QueryParser where
- QueryParser' {
  - fromQueryParser :: Text
  }
- pattern QueryParser_Dismax :: QueryParser
- pattern QueryParser_Lucene :: QueryParser
- pattern QueryParser_Simple :: QueryParser
- pattern QueryParser_Structured :: QueryParser
data Bucket = Bucket' {
- count :: Maybe Integer
- value :: Maybe Text
}
newBucket :: Bucket
bucket_count :: Lens' Bucket (Maybe Integer)
bucket_value :: Lens' Bucket (Maybe Text)
data BucketInfo = BucketInfo' {
- buckets :: Maybe [Bucket]
}
newBucketInfo :: BucketInfo
bucketInfo_buckets :: Lens' BucketInfo (Maybe [Bucket])
data DocumentServiceWarning = DocumentServiceWarning' {
- message :: Maybe Text
}
newDocumentServiceWarning :: DocumentServiceWarning
documentServiceWarning_message :: Lens' DocumentServiceWarning (Maybe Text)
data FieldStats = FieldStats' {
- count :: Maybe Integer
- max :: Maybe Text
- mean :: Maybe Text
- min :: Maybe Text
- missing :: Maybe Integer
- stddev :: Maybe Double
- sum :: Maybe Double
- sumOfSquares :: Maybe Double
}
newFieldStats :: FieldStats
fieldStats_count :: Lens' FieldStats (Maybe Integer)
fieldStats_max :: Lens' FieldStats (Maybe Text)
fieldStats_mean :: Lens' FieldStats (Maybe Text)
fieldStats_min :: Lens' FieldStats (Maybe Text)
fieldStats_missing :: Lens' FieldStats (Maybe Integer)
fieldStats_stddev :: Lens' FieldStats (Maybe Double)
fieldStats_sum :: Lens' FieldStats (Maybe Double)
fieldStats_sumOfSquares :: Lens' FieldStats (Maybe Double)
data Hit = Hit' {
- exprs :: Maybe (HashMap Text Text)
- fields :: Maybe (HashMap Text [Text])
- highlights :: Maybe (HashMap Text Text)
- id :: Maybe Text
}
newHit :: Hit
hit_exprs :: Lens' Hit (Maybe (HashMap Text Text))
hit_fields :: Lens' Hit (Maybe (HashMap Text [Text]))
hit_highlights :: Lens' Hit (Maybe (HashMap Text Text))
hit_id :: Lens' Hit (Maybe Text)
data Hits = Hits' {
- cursor :: Maybe Text
- found :: Maybe Integer
- hit :: Maybe [Hit]
- start :: Maybe Integer
}
newHits :: Hits
hits_cursor :: Lens' Hits (Maybe Text)
hits_found :: Lens' Hits (Maybe Integer)
hits_hit :: Lens' Hits (Maybe [Hit])
hits_start :: Lens' Hits (Maybe Integer)
data SearchStatus = SearchStatus' {
- rid :: Maybe Text
- timems :: Maybe Integer
}
newSearchStatus :: SearchStatus
searchStatus_rid :: Lens' SearchStatus (Maybe Text)
searchStatus_timems :: Lens' SearchStatus (Maybe Integer)
data SuggestModel = SuggestModel' {
- found :: Maybe Integer
- query :: Maybe Text
- suggestions :: Maybe [SuggestionMatch]
}
newSuggestModel :: SuggestModel
suggestModel_found :: Lens' SuggestModel (Maybe Integer)
suggestModel_query :: Lens' SuggestModel (Maybe Text)
suggestModel_suggestions :: Lens' SuggestModel (Maybe [SuggestionMatch])
data SuggestStatus = SuggestStatus' {
- rid :: Maybe Text
- timems :: Maybe Integer
}
newSuggestStatus :: SuggestStatus
suggestStatus_rid :: Lens' SuggestStatus (Maybe Text)
suggestStatus_timems :: Lens' SuggestStatus (Maybe Integer)
data SuggestionMatch = SuggestionMatch' {
- id :: Maybe Text
- score :: Maybe Integer
- suggestion :: Maybe Text
}
newSuggestionMatch :: SuggestionMatch
suggestionMatch_id :: Lens' SuggestionMatch (Maybe Text)
suggestionMatch_score :: Lens' SuggestionMatch (Maybe Integer)
suggestionMatch_suggestion :: 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 => Fold a ServiceError Source #

Information about any problems encountered while processing an upload request.

_SearchException :: AsError a => Fold a ServiceError Source #

Information about any problems encountered while processing a search request.

ContentType

newtype ContentType Source #

Constructors

ContentType'
Fields fromContentType :: Text

Bundled Patterns

pattern ContentType_Application_json :: ContentType
pattern ContentType_Application_xml :: ContentType

Instances

Instances details

FromJSON ContentType Source #
Instance details Defined in Amazonka.CloudSearchDomains.Types.ContentType Methods parseJSON :: Value -> Parser ContentType # parseJSONList :: Value -> Parser [ContentType] #
FromJSONKey ContentType Source #
Instance details Defined in Amazonka.CloudSearchDomains.Types.ContentType Methods fromJSONKey :: FromJSONKeyFunction ContentType # fromJSONKeyList :: FromJSONKeyFunction [ContentType] #
ToJSON ContentType Source #
Instance details Defined in Amazonka.CloudSearchDomains.Types.ContentType Methods toJSON :: ContentType -> Value # toEncoding :: ContentType -> Encoding # toJSONList :: [ContentType] -> Value # toEncodingList :: [ContentType] -> Encoding #
ToJSONKey ContentType Source #
Instance details Defined in Amazonka.CloudSearchDomains.Types.ContentType Methods toJSONKey :: ToJSONKeyFunction ContentType # toJSONKeyList :: ToJSONKeyFunction [ContentType] #
ToByteString ContentType Source #
Instance details Defined in Amazonka.CloudSearchDomains.Types.ContentType Methods toBS :: ContentType -> ByteString #
ToHeader ContentType Source #
Instance details Defined in Amazonka.CloudSearchDomains.Types.ContentType Methods toHeader :: HeaderName -> ContentType -> [Header] #
ToLog ContentType Source #
Instance details Defined in Amazonka.CloudSearchDomains.Types.ContentType Methods build :: ContentType -> ByteStringBuilder #
ToQuery ContentType Source #
Instance details Defined in Amazonka.CloudSearchDomains.Types.ContentType Methods toQuery :: ContentType -> QueryString #
FromText ContentType Source #
Instance details Defined in Amazonka.CloudSearchDomains.Types.ContentType Methods fromText :: Text -> Either String ContentType #
ToText ContentType Source #
Instance details Defined in Amazonka.CloudSearchDomains.Types.ContentType Methods toText :: ContentType -> Text #
FromXML ContentType Source #
Instance details Defined in Amazonka.CloudSearchDomains.Types.ContentType Methods parseXML :: [Node] -> Either String ContentType #
ToXML ContentType Source #
Instance details Defined in Amazonka.CloudSearchDomains.Types.ContentType Methods toXML :: ContentType -> XML #
Generic ContentType Source #
Instance details Defined in Amazonka.CloudSearchDomains.Types.ContentType Associated Types type Rep ContentType :: Type -> Type # Methods from :: ContentType -> Rep ContentType x # to :: Rep ContentType x -> ContentType #
Read ContentType Source #
Instance details Defined in Amazonka.CloudSearchDomains.Types.ContentType Methods readsPrec :: Int -> ReadS ContentType # readList :: ReadS [ContentType] # readPrec :: ReadPrec ContentType # readListPrec :: ReadPrec [ContentType] #
Show ContentType Source #
Instance details Defined in Amazonka.CloudSearchDomains.Types.ContentType Methods showsPrec :: Int -> ContentType -> ShowS # show :: ContentType -> String # showList :: [ContentType] -> ShowS #
NFData ContentType Source #
Instance details Defined in Amazonka.CloudSearchDomains.Types.ContentType Methods rnf :: ContentType -> () #
Eq ContentType Source #
Instance details Defined in Amazonka.CloudSearchDomains.Types.ContentType Methods (==) :: ContentType -> ContentType -> Bool # (/=) :: ContentType -> ContentType -> Bool #
Ord ContentType Source #
Instance details Defined in Amazonka.CloudSearchDomains.Types.ContentType Methods compare :: ContentType -> ContentType -> Ordering # (<) :: ContentType -> ContentType -> Bool # (<=) :: ContentType -> ContentType -> Bool # (>) :: ContentType -> ContentType -> Bool # (>=) :: ContentType -> ContentType -> Bool # max :: ContentType -> ContentType -> ContentType # min :: ContentType -> ContentType -> ContentType #
Hashable ContentType Source #
Instance details Defined in Amazonka.CloudSearchDomains.Types.ContentType Methods hashWithSalt :: Int -> ContentType -> Int # hash :: ContentType -> Int #
type Rep ContentType Source #
Instance details Defined in Amazonka.CloudSearchDomains.Types.ContentType type Rep ContentType = D1 ('MetaData "ContentType" "Amazonka.CloudSearchDomains.Types.ContentType" "amazonka-cloudsearch-domains-2.0-IDp90WQyZTIipPfNcVjL2" 'True) (C1 ('MetaCons "ContentType'" 'PrefixI 'True) (S1 ('MetaSel ('Just "fromContentType") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 Text)))

QueryParser

newtype QueryParser Source #

Constructors

QueryParser'
Fields fromQueryParser :: Text

Bundled Patterns

pattern QueryParser_Dismax :: QueryParser
pattern QueryParser_Lucene :: QueryParser
pattern QueryParser_Simple :: QueryParser
pattern QueryParser_Structured :: QueryParser

Instances

Instances details

FromJSON QueryParser Source #
Instance details Defined in Amazonka.CloudSearchDomains.Types.QueryParser Methods parseJSON :: Value -> Parser QueryParser # parseJSONList :: Value -> Parser [QueryParser] #
FromJSONKey QueryParser Source #
Instance details Defined in Amazonka.CloudSearchDomains.Types.QueryParser Methods fromJSONKey :: FromJSONKeyFunction QueryParser # fromJSONKeyList :: FromJSONKeyFunction [QueryParser] #
ToJSON QueryParser Source #
Instance details Defined in Amazonka.CloudSearchDomains.Types.QueryParser Methods toJSON :: QueryParser -> Value # toEncoding :: QueryParser -> Encoding # toJSONList :: [QueryParser] -> Value # toEncodingList :: [QueryParser] -> Encoding #
ToJSONKey QueryParser Source #
Instance details Defined in Amazonka.CloudSearchDomains.Types.QueryParser Methods toJSONKey :: ToJSONKeyFunction QueryParser # toJSONKeyList :: ToJSONKeyFunction [QueryParser] #
ToByteString QueryParser Source #
Instance details Defined in Amazonka.CloudSearchDomains.Types.QueryParser Methods toBS :: QueryParser -> ByteString #
ToHeader QueryParser Source #
Instance details Defined in Amazonka.CloudSearchDomains.Types.QueryParser Methods toHeader :: HeaderName -> QueryParser -> [Header] #
ToLog QueryParser Source #
Instance details Defined in Amazonka.CloudSearchDomains.Types.QueryParser Methods build :: QueryParser -> ByteStringBuilder #
ToQuery QueryParser Source #
Instance details Defined in Amazonka.CloudSearchDomains.Types.QueryParser Methods toQuery :: QueryParser -> QueryString #
FromText QueryParser Source #
Instance details Defined in Amazonka.CloudSearchDomains.Types.QueryParser Methods fromText :: Text -> Either String QueryParser #
ToText QueryParser Source #
Instance details Defined in Amazonka.CloudSearchDomains.Types.QueryParser Methods toText :: QueryParser -> Text #
FromXML QueryParser Source #
Instance details Defined in Amazonka.CloudSearchDomains.Types.QueryParser Methods parseXML :: [Node] -> Either String QueryParser #
ToXML QueryParser Source #
Instance details Defined in Amazonka.CloudSearchDomains.Types.QueryParser Methods toXML :: QueryParser -> XML #
Generic QueryParser Source #
Instance details Defined in Amazonka.CloudSearchDomains.Types.QueryParser Associated Types type Rep QueryParser :: Type -> Type # Methods from :: QueryParser -> Rep QueryParser x # to :: Rep QueryParser x -> QueryParser #
Read QueryParser Source #
Instance details Defined in Amazonka.CloudSearchDomains.Types.QueryParser Methods readsPrec :: Int -> ReadS QueryParser # readList :: ReadS [QueryParser] # readPrec :: ReadPrec QueryParser # readListPrec :: ReadPrec [QueryParser] #
Show QueryParser Source #
Instance details Defined in Amazonka.CloudSearchDomains.Types.QueryParser Methods showsPrec :: Int -> QueryParser -> ShowS # show :: QueryParser -> String # showList :: [QueryParser] -> ShowS #
NFData QueryParser Source #
Instance details Defined in Amazonka.CloudSearchDomains.Types.QueryParser Methods rnf :: QueryParser -> () #
Eq QueryParser Source #
Instance details Defined in Amazonka.CloudSearchDomains.Types.QueryParser Methods (==) :: QueryParser -> QueryParser -> Bool # (/=) :: QueryParser -> QueryParser -> Bool #
Ord QueryParser Source #
Instance details Defined in Amazonka.CloudSearchDomains.Types.QueryParser Methods compare :: QueryParser -> QueryParser -> Ordering # (<) :: QueryParser -> QueryParser -> Bool # (<=) :: QueryParser -> QueryParser -> Bool # (>) :: QueryParser -> QueryParser -> Bool # (>=) :: QueryParser -> QueryParser -> Bool # max :: QueryParser -> QueryParser -> QueryParser # min :: QueryParser -> QueryParser -> QueryParser #
Hashable QueryParser Source #
Instance details Defined in Amazonka.CloudSearchDomains.Types.QueryParser Methods hashWithSalt :: Int -> QueryParser -> Int # hash :: QueryParser -> Int #
type Rep QueryParser Source #
Instance details Defined in Amazonka.CloudSearchDomains.Types.QueryParser type Rep QueryParser = D1 ('MetaData "QueryParser" "Amazonka.CloudSearchDomains.Types.QueryParser" "amazonka-cloudsearch-domains-2.0-IDp90WQyZTIipPfNcVjL2" 'True) (C1 ('MetaCons "QueryParser'" 'PrefixI 'True) (S1 ('MetaSel ('Just "fromQueryParser") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 Text)))

Bucket

data Bucket Source #

A container for facet information.

See: newBucket smart constructor.

Constructors

Bucket'
Fields count :: Maybe Integer The number of hits that contain the facet value in the specified facet field. value :: Maybe Text The facet value being counted.

Instances

Instances details

FromJSON Bucket Source #
Instance details Defined in Amazonka.CloudSearchDomains.Types.Bucket Methods parseJSON :: Value -> Parser Bucket # parseJSONList :: Value -> Parser [Bucket] #
Generic Bucket Source #
Instance details Defined in Amazonka.CloudSearchDomains.Types.Bucket Associated Types type Rep Bucket :: Type -> Type # Methods from :: Bucket -> Rep Bucket x # to :: Rep Bucket x -> Bucket #
Read Bucket Source #
Instance details Defined in Amazonka.CloudSearchDomains.Types.Bucket Methods readsPrec :: Int -> ReadS Bucket # readList :: ReadS [Bucket] # readPrec :: ReadPrec Bucket # readListPrec :: ReadPrec [Bucket] #
Show Bucket Source #
Instance details Defined in Amazonka.CloudSearchDomains.Types.Bucket Methods showsPrec :: Int -> Bucket -> ShowS # show :: Bucket -> String # showList :: [Bucket] -> ShowS #
NFData Bucket Source #
Instance details Defined in Amazonka.CloudSearchDomains.Types.Bucket Methods rnf :: Bucket -> () #
Eq Bucket Source #
Instance details Defined in Amazonka.CloudSearchDomains.Types.Bucket Methods (==) :: Bucket -> Bucket -> Bool # (/=) :: Bucket -> Bucket -> Bool #
Hashable Bucket Source #
Instance details Defined in Amazonka.CloudSearchDomains.Types.Bucket Methods hashWithSalt :: Int -> Bucket -> Int # hash :: Bucket -> Int #
type Rep Bucket Source #
Instance details Defined in Amazonka.CloudSearchDomains.Types.Bucket type Rep Bucket = D1 ('MetaData "Bucket" "Amazonka.CloudSearchDomains.Types.Bucket" "amazonka-cloudsearch-domains-2.0-IDp90WQyZTIipPfNcVjL2" 'False) (C1 ('MetaCons "Bucket'" 'PrefixI 'True) (S1 ('MetaSel ('Just "count") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Integer)) :*: S1 ('MetaSel ('Just "value") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text))))

newBucket :: Bucket Source #

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:count:Bucket', bucket_count - The number of hits that contain the facet value in the specified facet field.

$sel:value:Bucket', bucket_value - The facet value being counted.

bucket_count :: Lens' Bucket (Maybe Integer) Source #

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

bucket_value :: Lens' Bucket (Maybe Text) Source #

The facet value being counted.

BucketInfo

data BucketInfo Source #

A container for the calculated facet values and counts.

See: newBucketInfo smart constructor.

Constructors

BucketInfo'
Fields buckets :: Maybe [Bucket] A list of the calculated facet values and counts.

Instances

Instances details

FromJSON BucketInfo Source #
Instance details Defined in Amazonka.CloudSearchDomains.Types.BucketInfo Methods parseJSON :: Value -> Parser BucketInfo # parseJSONList :: Value -> Parser [BucketInfo] #
Generic BucketInfo Source #
Instance details Defined in Amazonka.CloudSearchDomains.Types.BucketInfo Associated Types type Rep BucketInfo :: Type -> Type # Methods from :: BucketInfo -> Rep BucketInfo x # to :: Rep BucketInfo x -> BucketInfo #
Read BucketInfo Source #
Instance details Defined in Amazonka.CloudSearchDomains.Types.BucketInfo Methods readsPrec :: Int -> ReadS BucketInfo # readList :: ReadS [BucketInfo] # readPrec :: ReadPrec BucketInfo # readListPrec :: ReadPrec [BucketInfo] #
Show BucketInfo Source #
Instance details Defined in Amazonka.CloudSearchDomains.Types.BucketInfo Methods showsPrec :: Int -> BucketInfo -> ShowS # show :: BucketInfo -> String # showList :: [BucketInfo] -> ShowS #
NFData BucketInfo Source #
Instance details Defined in Amazonka.CloudSearchDomains.Types.BucketInfo Methods rnf :: BucketInfo -> () #
Eq BucketInfo Source #
Instance details Defined in Amazonka.CloudSearchDomains.Types.BucketInfo Methods (==) :: BucketInfo -> BucketInfo -> Bool # (/=) :: BucketInfo -> BucketInfo -> Bool #
Hashable BucketInfo Source #
Instance details Defined in Amazonka.CloudSearchDomains.Types.BucketInfo Methods hashWithSalt :: Int -> BucketInfo -> Int # hash :: BucketInfo -> Int #
type Rep BucketInfo Source #
Instance details Defined in Amazonka.CloudSearchDomains.Types.BucketInfo type Rep BucketInfo = D1 ('MetaData "BucketInfo" "Amazonka.CloudSearchDomains.Types.BucketInfo" "amazonka-cloudsearch-domains-2.0-IDp90WQyZTIipPfNcVjL2" 'False) (C1 ('MetaCons "BucketInfo'" 'PrefixI 'True) (S1 ('MetaSel ('Just "buckets") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe [Bucket]))))

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.

Constructors

DocumentServiceWarning'
Fields message :: Maybe Text The description for a warning returned by the document service.

Instances

Instances details

FromJSON DocumentServiceWarning Source #
Instance details Defined in Amazonka.CloudSearchDomains.Types.DocumentServiceWarning Methods parseJSON :: Value -> Parser DocumentServiceWarning # parseJSONList :: Value -> Parser [DocumentServiceWarning] #
Generic DocumentServiceWarning Source #
Instance details Defined in Amazonka.CloudSearchDomains.Types.DocumentServiceWarning Associated Types type Rep DocumentServiceWarning :: Type -> Type # Methods from :: DocumentServiceWarning -> Rep DocumentServiceWarning x # to :: Rep DocumentServiceWarning x -> DocumentServiceWarning #
Read DocumentServiceWarning Source #
Instance details Defined in Amazonka.CloudSearchDomains.Types.DocumentServiceWarning Methods readsPrec :: Int -> ReadS DocumentServiceWarning # readList :: ReadS [DocumentServiceWarning] # readPrec :: ReadPrec DocumentServiceWarning # readListPrec :: ReadPrec [DocumentServiceWarning] #
Show DocumentServiceWarning Source #
Instance details Defined in Amazonka.CloudSearchDomains.Types.DocumentServiceWarning Methods showsPrec :: Int -> DocumentServiceWarning -> ShowS # show :: DocumentServiceWarning -> String # showList :: [DocumentServiceWarning] -> ShowS #
NFData DocumentServiceWarning Source #
Instance details Defined in Amazonka.CloudSearchDomains.Types.DocumentServiceWarning Methods rnf :: DocumentServiceWarning -> () #
Eq DocumentServiceWarning Source #
Instance details Defined in Amazonka.CloudSearchDomains.Types.DocumentServiceWarning Methods (==) :: DocumentServiceWarning -> DocumentServiceWarning -> Bool # (/=) :: DocumentServiceWarning -> DocumentServiceWarning -> Bool #
Hashable DocumentServiceWarning Source #
Instance details Defined in Amazonka.CloudSearchDomains.Types.DocumentServiceWarning Methods hashWithSalt :: Int -> DocumentServiceWarning -> Int # hash :: DocumentServiceWarning -> Int #
type Rep DocumentServiceWarning Source #
Instance details Defined in Amazonka.CloudSearchDomains.Types.DocumentServiceWarning type Rep DocumentServiceWarning = D1 ('MetaData "DocumentServiceWarning" "Amazonka.CloudSearchDomains.Types.DocumentServiceWarning" "amazonka-cloudsearch-domains-2.0-IDp90WQyZTIipPfNcVjL2" 'False) (C1 ('MetaCons "DocumentServiceWarning'" 'PrefixI 'True) (S1 ('MetaSel ('Just "message") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text))))

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.

Constructors

FieldStats'

Fields

count :: Maybe Integer
The number of documents that contain a value in the specified field in the result set.
max :: Maybe Text
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.
mean :: Maybe Text
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.
min :: Maybe Text
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.
missing :: Maybe Integer
The number of documents that do not contain a value in the specified field in the result set.
stddev :: Maybe Double
The standard deviation of the values in the specified field in the result set.
sum :: Maybe Double
The sum of the field values across the documents in the result set. null for date fields.
sumOfSquares :: Maybe Double
The sum of all field values in the result set squared.

Instances

Instances details

FromJSON FieldStats Source #
Instance details Defined in Amazonka.CloudSearchDomains.Types.FieldStats Methods parseJSON :: Value -> Parser FieldStats # parseJSONList :: Value -> Parser [FieldStats] #
Generic FieldStats Source #
Instance details Defined in Amazonka.CloudSearchDomains.Types.FieldStats Associated Types type Rep FieldStats :: Type -> Type # Methods from :: FieldStats -> Rep FieldStats x # to :: Rep FieldStats x -> FieldStats #
Read FieldStats Source #
Instance details Defined in Amazonka.CloudSearchDomains.Types.FieldStats Methods readsPrec :: Int -> ReadS FieldStats # readList :: ReadS [FieldStats] # readPrec :: ReadPrec FieldStats # readListPrec :: ReadPrec [FieldStats] #
Show FieldStats Source #
Instance details Defined in Amazonka.CloudSearchDomains.Types.FieldStats Methods showsPrec :: Int -> FieldStats -> ShowS # show :: FieldStats -> String # showList :: [FieldStats] -> ShowS #
NFData FieldStats Source #
Instance details Defined in Amazonka.CloudSearchDomains.Types.FieldStats Methods rnf :: FieldStats -> () #
Eq FieldStats Source #
Instance details Defined in Amazonka.CloudSearchDomains.Types.FieldStats Methods (==) :: FieldStats -> FieldStats -> Bool # (/=) :: FieldStats -> FieldStats -> Bool #
Hashable FieldStats Source #
Instance details Defined in Amazonka.CloudSearchDomains.Types.FieldStats Methods hashWithSalt :: Int -> FieldStats -> Int # hash :: FieldStats -> Int #
type Rep FieldStats Source #
Instance details Defined in Amazonka.CloudSearchDomains.Types.FieldStats type Rep FieldStats = D1 ('MetaData "FieldStats" "Amazonka.CloudSearchDomains.Types.FieldStats" "amazonka-cloudsearch-domains-2.0-IDp90WQyZTIipPfNcVjL2" 'False) (C1 ('MetaCons "FieldStats'" 'PrefixI 'True) (((S1 ('MetaSel ('Just "count") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Integer)) :: S1 ('MetaSel ('Just "max") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text))) :: (S1 ('MetaSel ('Just "mean") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :: S1 ('MetaSel ('Just "min") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)))) :: ((S1 ('MetaSel ('Just "missing") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Integer)) :: S1 ('MetaSel ('Just "stddev") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Double))) :: (S1 ('MetaSel ('Just "sum") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Double)) :*: S1 ('MetaSel ('Just "sumOfSquares") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Double))))))

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:count:FieldStats', fieldStats_count - The number of documents that contain a value in the specified field in the result set.

$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: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: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:sum:FieldStats', fieldStats_sum - The sum of the field values across the documents in the result set. null for date fields.

$sel:sumOfSquares:FieldStats', fieldStats_sumOfSquares - The sum of all field values in the result set squared.

fieldStats_count :: Lens' FieldStats (Maybe Integer) Source #

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

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_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_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_sum :: Lens' FieldStats (Maybe Double) Source #

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

fieldStats_sumOfSquares :: Lens' FieldStats (Maybe Double) Source #

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

Hit

data Hit Source #

Information about a document that matches the search request.

See: newHit smart constructor.

Constructors

Hit'

Fields

exprs :: Maybe (HashMap Text Text)
The expressions returned from a document that matches the search request.
fields :: Maybe (HashMap Text [Text])
The fields returned from a document that matches the search request.
highlights :: Maybe (HashMap Text Text)
The highlights returned from a document that matches the search request.
id :: Maybe Text
The document ID of a document that matches the search request.

Instances

Instances details

FromJSON Hit Source #
Instance details Defined in Amazonka.CloudSearchDomains.Types.Hit Methods parseJSON :: Value -> Parser Hit # parseJSONList :: Value -> Parser [Hit] #
Generic Hit Source #
Instance details Defined in Amazonka.CloudSearchDomains.Types.Hit Associated Types type Rep Hit :: Type -> Type # Methods from :: Hit -> Rep Hit x # to :: Rep Hit x -> Hit #
Read Hit Source #
Instance details Defined in Amazonka.CloudSearchDomains.Types.Hit Methods readsPrec :: Int -> ReadS Hit # readList :: ReadS [Hit] # readPrec :: ReadPrec Hit # readListPrec :: ReadPrec [Hit] #
Show Hit Source #
Instance details Defined in Amazonka.CloudSearchDomains.Types.Hit Methods showsPrec :: Int -> Hit -> ShowS # show :: Hit -> String # showList :: [Hit] -> ShowS #
NFData Hit Source #
Instance details Defined in Amazonka.CloudSearchDomains.Types.Hit Methods rnf :: Hit -> () #
Eq Hit Source #
Instance details Defined in Amazonka.CloudSearchDomains.Types.Hit Methods (==) :: Hit -> Hit -> Bool # (/=) :: Hit -> Hit -> Bool #
Hashable Hit Source #
Instance details Defined in Amazonka.CloudSearchDomains.Types.Hit Methods hashWithSalt :: Int -> Hit -> Int # hash :: Hit -> Int #
type Rep Hit Source #
Instance details Defined in Amazonka.CloudSearchDomains.Types.Hit type Rep Hit = D1 ('MetaData "Hit" "Amazonka.CloudSearchDomains.Types.Hit" "amazonka-cloudsearch-domains-2.0-IDp90WQyZTIipPfNcVjL2" 'False) (C1 ('MetaCons "Hit'" 'PrefixI 'True) ((S1 ('MetaSel ('Just "exprs") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe (HashMap Text Text))) :: S1 ('MetaSel ('Just "fields") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe (HashMap Text [Text])))) :: (S1 ('MetaSel ('Just "highlights") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe (HashMap Text Text))) :*: S1 ('MetaSel ('Just "id") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)))))

newHit :: Hit Source #

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:fields:Hit', hit_fields - The fields returned from a document that matches the search request.

$sel:highlights:Hit', hit_highlights - The highlights 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.

hit_exprs :: Lens' Hit (Maybe (HashMap Text Text)) Source #

The expressions 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.

hit_highlights :: Lens' Hit (Maybe (HashMap Text Text)) Source #

The highlights 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.

Hits

data Hits Source #

The collection of documents that match the search request.

See: newHits smart constructor.

Constructors

Hits'
Fields cursor :: Maybe Text A cursor that can be used to retrieve the next set of matching documents when you want to page through a large result set. found :: Maybe Integer The total number of documents that match the search request. hit :: Maybe [Hit] A document that matches the search request. start :: Maybe Integer The index of the first matching document.

Instances

Instances details

FromJSON Hits Source #
Instance details Defined in Amazonka.CloudSearchDomains.Types.Hits Methods parseJSON :: Value -> Parser Hits # parseJSONList :: Value -> Parser [Hits] #
Generic Hits Source #
Instance details Defined in Amazonka.CloudSearchDomains.Types.Hits Associated Types type Rep Hits :: Type -> Type # Methods from :: Hits -> Rep Hits x # to :: Rep Hits x -> Hits #
Read Hits Source #
Instance details Defined in Amazonka.CloudSearchDomains.Types.Hits Methods readsPrec :: Int -> ReadS Hits # readList :: ReadS [Hits] # readPrec :: ReadPrec Hits # readListPrec :: ReadPrec [Hits] #
Show Hits Source #
Instance details Defined in Amazonka.CloudSearchDomains.Types.Hits Methods showsPrec :: Int -> Hits -> ShowS # show :: Hits -> String # showList :: [Hits] -> ShowS #
NFData Hits Source #
Instance details Defined in Amazonka.CloudSearchDomains.Types.Hits Methods rnf :: Hits -> () #
Eq Hits Source #
Instance details Defined in Amazonka.CloudSearchDomains.Types.Hits Methods (==) :: Hits -> Hits -> Bool # (/=) :: Hits -> Hits -> Bool #
Hashable Hits Source #
Instance details Defined in Amazonka.CloudSearchDomains.Types.Hits Methods hashWithSalt :: Int -> Hits -> Int # hash :: Hits -> Int #
type Rep Hits Source #
Instance details Defined in Amazonka.CloudSearchDomains.Types.Hits type Rep Hits = D1 ('MetaData "Hits" "Amazonka.CloudSearchDomains.Types.Hits" "amazonka-cloudsearch-domains-2.0-IDp90WQyZTIipPfNcVjL2" 'False) (C1 ('MetaCons "Hits'" 'PrefixI 'True) ((S1 ('MetaSel ('Just "cursor") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :: S1 ('MetaSel ('Just "found") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Integer))) :: (S1 ('MetaSel ('Just "hit") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe [Hit])) :*: S1 ('MetaSel ('Just "start") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Integer)))))

newHits :: Hits Source #

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:found:Hits', hits_found - The total number of documents that match the search request.

$sel:hit:Hits', hits_hit - A document that matches the search request.

$sel:start:Hits', hits_start - The index of the first matching document.

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.

hits_hit :: Lens' Hits (Maybe [Hit]) Source #

A document that matches the search request.

hits_start :: Lens' Hits (Maybe Integer) Source #

The index of the first matching document.

SearchStatus

data SearchStatus Source #

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

See: newSearchStatus smart constructor.

Constructors

SearchStatus'
Fields rid :: Maybe Text The encrypted resource ID for the request. timems :: Maybe Integer How long it took to process the request, in milliseconds.

Instances

Instances details

FromJSON SearchStatus Source #
Instance details Defined in Amazonka.CloudSearchDomains.Types.SearchStatus Methods parseJSON :: Value -> Parser SearchStatus # parseJSONList :: Value -> Parser [SearchStatus] #
Generic SearchStatus Source #
Instance details Defined in Amazonka.CloudSearchDomains.Types.SearchStatus Associated Types type Rep SearchStatus :: Type -> Type # Methods from :: SearchStatus -> Rep SearchStatus x # to :: Rep SearchStatus x -> SearchStatus #
Read SearchStatus Source #
Instance details Defined in Amazonka.CloudSearchDomains.Types.SearchStatus Methods readsPrec :: Int -> ReadS SearchStatus # readList :: ReadS [SearchStatus] # readPrec :: ReadPrec SearchStatus # readListPrec :: ReadPrec [SearchStatus] #
Show SearchStatus Source #
Instance details Defined in Amazonka.CloudSearchDomains.Types.SearchStatus Methods showsPrec :: Int -> SearchStatus -> ShowS # show :: SearchStatus -> String # showList :: [SearchStatus] -> ShowS #
NFData SearchStatus Source #
Instance details Defined in Amazonka.CloudSearchDomains.Types.SearchStatus Methods rnf :: SearchStatus -> () #
Eq SearchStatus Source #
Instance details Defined in Amazonka.CloudSearchDomains.Types.SearchStatus Methods (==) :: SearchStatus -> SearchStatus -> Bool # (/=) :: SearchStatus -> SearchStatus -> Bool #
Hashable SearchStatus Source #
Instance details Defined in Amazonka.CloudSearchDomains.Types.SearchStatus Methods hashWithSalt :: Int -> SearchStatus -> Int # hash :: SearchStatus -> Int #
type Rep SearchStatus Source #
Instance details Defined in Amazonka.CloudSearchDomains.Types.SearchStatus type Rep SearchStatus = D1 ('MetaData "SearchStatus" "Amazonka.CloudSearchDomains.Types.SearchStatus" "amazonka-cloudsearch-domains-2.0-IDp90WQyZTIipPfNcVjL2" 'False) (C1 ('MetaCons "SearchStatus'" 'PrefixI 'True) (S1 ('MetaSel ('Just "rid") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :*: S1 ('MetaSel ('Just "timems") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Integer))))

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.

Constructors

SuggestModel'
Fields found :: Maybe Integer The number of documents that were found to match the query string. query :: Maybe Text The query string specified in the suggest request. suggestions :: Maybe [SuggestionMatch] The documents that match the query string.

Instances

Instances details

FromJSON SuggestModel Source #
Instance details Defined in Amazonka.CloudSearchDomains.Types.SuggestModel Methods parseJSON :: Value -> Parser SuggestModel # parseJSONList :: Value -> Parser [SuggestModel] #
Generic SuggestModel Source #
Instance details Defined in Amazonka.CloudSearchDomains.Types.SuggestModel Associated Types type Rep SuggestModel :: Type -> Type # Methods from :: SuggestModel -> Rep SuggestModel x # to :: Rep SuggestModel x -> SuggestModel #
Read SuggestModel Source #
Instance details Defined in Amazonka.CloudSearchDomains.Types.SuggestModel Methods readsPrec :: Int -> ReadS SuggestModel # readList :: ReadS [SuggestModel] # readPrec :: ReadPrec SuggestModel # readListPrec :: ReadPrec [SuggestModel] #
Show SuggestModel Source #
Instance details Defined in Amazonka.CloudSearchDomains.Types.SuggestModel Methods showsPrec :: Int -> SuggestModel -> ShowS # show :: SuggestModel -> String # showList :: [SuggestModel] -> ShowS #
NFData SuggestModel Source #
Instance details Defined in Amazonka.CloudSearchDomains.Types.SuggestModel Methods rnf :: SuggestModel -> () #
Eq SuggestModel Source #
Instance details Defined in Amazonka.CloudSearchDomains.Types.SuggestModel Methods (==) :: SuggestModel -> SuggestModel -> Bool # (/=) :: SuggestModel -> SuggestModel -> Bool #
Hashable SuggestModel Source #
Instance details Defined in Amazonka.CloudSearchDomains.Types.SuggestModel Methods hashWithSalt :: Int -> SuggestModel -> Int # hash :: SuggestModel -> Int #
type Rep SuggestModel Source #
Instance details Defined in Amazonka.CloudSearchDomains.Types.SuggestModel type Rep SuggestModel = D1 ('MetaData "SuggestModel" "Amazonka.CloudSearchDomains.Types.SuggestModel" "amazonka-cloudsearch-domains-2.0-IDp90WQyZTIipPfNcVjL2" 'False) (C1 ('MetaCons "SuggestModel'" 'PrefixI 'True) (S1 ('MetaSel ('Just "found") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Integer)) :: (S1 ('MetaSel ('Just "query") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :: S1 ('MetaSel ('Just "suggestions") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe [SuggestionMatch])))))

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:query:SuggestModel', suggestModel_query - The query string specified in the suggest request.

$sel:suggestions:SuggestModel', suggestModel_suggestions - The documents that match the query string.

suggestModel_found :: Lens' SuggestModel (Maybe Integer) Source #

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

suggestModel_query :: Lens' SuggestModel (Maybe Text) Source #

The query string specified in the suggest request.

suggestModel_suggestions :: Lens' SuggestModel (Maybe [SuggestionMatch]) Source #

The documents that match the query string.

SuggestStatus

data SuggestStatus Source #

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

See: newSuggestStatus smart constructor.

Constructors

SuggestStatus'
Fields rid :: Maybe Text The encrypted resource ID for the request. timems :: Maybe Integer How long it took to process the request, in milliseconds.

Instances

Instances details

FromJSON SuggestStatus Source #
Instance details Defined in Amazonka.CloudSearchDomains.Types.SuggestStatus Methods parseJSON :: Value -> Parser SuggestStatus # parseJSONList :: Value -> Parser [SuggestStatus] #
Generic SuggestStatus Source #
Instance details Defined in Amazonka.CloudSearchDomains.Types.SuggestStatus Associated Types type Rep SuggestStatus :: Type -> Type # Methods from :: SuggestStatus -> Rep SuggestStatus x # to :: Rep SuggestStatus x -> SuggestStatus #
Read SuggestStatus Source #
Instance details Defined in Amazonka.CloudSearchDomains.Types.SuggestStatus Methods readsPrec :: Int -> ReadS SuggestStatus # readList :: ReadS [SuggestStatus] # readPrec :: ReadPrec SuggestStatus # readListPrec :: ReadPrec [SuggestStatus] #
Show SuggestStatus Source #
Instance details Defined in Amazonka.CloudSearchDomains.Types.SuggestStatus Methods showsPrec :: Int -> SuggestStatus -> ShowS # show :: SuggestStatus -> String # showList :: [SuggestStatus] -> ShowS #
NFData SuggestStatus Source #
Instance details Defined in Amazonka.CloudSearchDomains.Types.SuggestStatus Methods rnf :: SuggestStatus -> () #
Eq SuggestStatus Source #
Instance details Defined in Amazonka.CloudSearchDomains.Types.SuggestStatus Methods (==) :: SuggestStatus -> SuggestStatus -> Bool # (/=) :: SuggestStatus -> SuggestStatus -> Bool #
Hashable SuggestStatus Source #
Instance details Defined in Amazonka.CloudSearchDomains.Types.SuggestStatus Methods hashWithSalt :: Int -> SuggestStatus -> Int # hash :: SuggestStatus -> Int #
type Rep SuggestStatus Source #
Instance details Defined in Amazonka.CloudSearchDomains.Types.SuggestStatus type Rep SuggestStatus = D1 ('MetaData "SuggestStatus" "Amazonka.CloudSearchDomains.Types.SuggestStatus" "amazonka-cloudsearch-domains-2.0-IDp90WQyZTIipPfNcVjL2" 'False) (C1 ('MetaCons "SuggestStatus'" 'PrefixI 'True) (S1 ('MetaSel ('Just "rid") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :*: S1 ('MetaSel ('Just "timems") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Integer))))

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.

Constructors

SuggestionMatch'
Fields id :: Maybe Text The document ID of the suggested document. score :: Maybe Integer The relevance score of a suggested match. suggestion :: Maybe Text The string that matches the query string specified in the `SuggestRequest`.

Instances

Instances details

FromJSON SuggestionMatch Source #
Instance details Defined in Amazonka.CloudSearchDomains.Types.SuggestionMatch Methods parseJSON :: Value -> Parser SuggestionMatch # parseJSONList :: Value -> Parser [SuggestionMatch] #
Generic SuggestionMatch Source #
Instance details Defined in Amazonka.CloudSearchDomains.Types.SuggestionMatch Associated Types type Rep SuggestionMatch :: Type -> Type # Methods from :: SuggestionMatch -> Rep SuggestionMatch x # to :: Rep SuggestionMatch x -> SuggestionMatch #
Read SuggestionMatch Source #
Instance details Defined in Amazonka.CloudSearchDomains.Types.SuggestionMatch Methods readsPrec :: Int -> ReadS SuggestionMatch # readList :: ReadS [SuggestionMatch] # readPrec :: ReadPrec SuggestionMatch # readListPrec :: ReadPrec [SuggestionMatch] #
Show SuggestionMatch Source #
Instance details Defined in Amazonka.CloudSearchDomains.Types.SuggestionMatch Methods showsPrec :: Int -> SuggestionMatch -> ShowS # show :: SuggestionMatch -> String # showList :: [SuggestionMatch] -> ShowS #
NFData SuggestionMatch Source #
Instance details Defined in Amazonka.CloudSearchDomains.Types.SuggestionMatch Methods rnf :: SuggestionMatch -> () #
Eq SuggestionMatch Source #
Instance details Defined in Amazonka.CloudSearchDomains.Types.SuggestionMatch Methods (==) :: SuggestionMatch -> SuggestionMatch -> Bool # (/=) :: SuggestionMatch -> SuggestionMatch -> Bool #
Hashable SuggestionMatch Source #
Instance details Defined in Amazonka.CloudSearchDomains.Types.SuggestionMatch Methods hashWithSalt :: Int -> SuggestionMatch -> Int # hash :: SuggestionMatch -> Int #
type Rep SuggestionMatch Source #
Instance details Defined in Amazonka.CloudSearchDomains.Types.SuggestionMatch type Rep SuggestionMatch = D1 ('MetaData "SuggestionMatch" "Amazonka.CloudSearchDomains.Types.SuggestionMatch" "amazonka-cloudsearch-domains-2.0-IDp90WQyZTIipPfNcVjL2" 'False) (C1 ('MetaCons "SuggestionMatch'" 'PrefixI 'True) (S1 ('MetaSel ('Just "id") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :: (S1 ('MetaSel ('Just "score") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Integer)) :: S1 ('MetaSel ('Just "suggestion") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)))))

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:id:SuggestionMatch', suggestionMatch_id - The document ID of the suggested document.

$sel:score:SuggestionMatch', suggestionMatch_score - The relevance score of a suggested match.

$sel:suggestion:SuggestionMatch', suggestionMatch_suggestion - The string that matches the query string specified in the SuggestRequest.

suggestionMatch_id :: Lens' SuggestionMatch (Maybe Text) Source #

The document ID of the suggested document.

suggestionMatch_score :: Lens' SuggestionMatch (Maybe Integer) Source #

The relevance score of a suggested match.

suggestionMatch_suggestion :: Lens' SuggestionMatch (Maybe Text) Source #

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