Network.AWS.CloudSearchDomains

You use the AmazonCloudSearch2013 API to upload documents to a search domain and search those documents.

The endpoints for submitting UploadDocuments , Search , and Suggest requests are domain-specific. To get the endpoints for your domain, use the Amazon CloudSearch configuration service DescribeDomains action. The domain endpoints are also displayed on the domain dashboard in the Amazon CloudSearch console. You submit suggest requests to the search endpoint.

For more information, see the Amazon CloudSearch Developer Guide .

Service Configuration

cloudSearchDomains :: Service

API version 2013-01-01 of the Amazon CloudSearch Domain SDK configuration.

Errors

Error matchers are designed for use with the functions provided by Control.Exception.Lens. This allows catching (and rethrowing) service specific errors returned by CloudSearchDomains.

DocumentServiceException

_DocumentServiceException :: AsError a => Getting (First ServiceError) a ServiceError

Information about any problems encountered while processing an upload request.

SearchException

_SearchException :: AsError a => Getting (First ServiceError) a ServiceError

Information about any problems encountered while processing a search request.

Waiters

Waiters poll by repeatedly sending a request until some remote success condition configured by the Wait specification is fulfilled. The Wait specification determines how many attempts should be made, in addition to delay and retry strategies.

Operations

Some AWS operations return results that are incomplete and require subsequent requests in order to obtain the entire result set. The process of sending subsequent requests to continue where a previous request left off is called pagination. For example, the ListObjects operation of Amazon S3 returns up to 1000 objects at a time, and you must send subsequent requests with the appropriate Marker in order to retrieve the next page of results.

Operations that have an AWSPager instance can transparently perform subsequent requests, correctly setting Markers and other request facets to iterate through the entire result set of a truncated API operation. Operations which support this have an additional note in the documentation.

Many operations have the ability to filter results on the server side. See the individual operation parameters for details.

Suggest

module Network.AWS.CloudSearchDomains.Suggest

UploadDocuments

module Network.AWS.CloudSearchDomains.UploadDocuments

Search

module Network.AWS.CloudSearchDomains.Search

Types

ContentType

data ContentType

Constructors

ApplicationJSON

ApplicationXML

Instances

Bounded ContentType

Methods

minBound :: ContentType

maxBound :: ContentType

Enum ContentType

Methods

succ :: ContentType -> ContentType

pred :: ContentType -> ContentType

toEnum :: Int -> ContentType

fromEnum :: ContentType -> Int

enumFrom :: ContentType -> [ContentType]

enumFromThen :: ContentType -> ContentType -> [ContentType]

enumFromTo :: ContentType -> ContentType -> [ContentType]

enumFromThenTo :: ContentType -> ContentType -> ContentType -> [ContentType]

Eq ContentType

Methods

(==) :: ContentType -> ContentType -> Bool

(/=) :: ContentType -> ContentType -> Bool

Data ContentType

Methods

gfoldl :: (forall d b. Data d => c (d -> b) -> d -> c b) -> (forall g. g -> c g) -> ContentType -> c ContentType

gunfold :: (forall b r. Data b => c (b -> r) -> c r) -> (forall r. r -> c r) -> Constr -> c ContentType

toConstr :: ContentType -> Constr

dataTypeOf :: ContentType -> DataType

dataCast1 :: Typeable (* -> *) t => (forall d. Data d => c (t d)) -> Maybe (c ContentType)

dataCast2 :: Typeable (* -> * -> *) t => (forall d e. (Data d, Data e) => c (t d e)) -> Maybe (c ContentType)

gmapT :: (forall b. Data b => b -> b) -> ContentType -> ContentType

gmapQl :: (r -> r' -> r) -> r -> (forall d. Data d => d -> r') -> ContentType -> r

gmapQr :: (r' -> r -> r) -> r -> (forall d. Data d => d -> r') -> ContentType -> r

gmapQ :: (forall d. Data d => d -> u) -> ContentType -> [u]

gmapQi :: Int -> (forall d. Data d => d -> u) -> ContentType -> u

gmapM :: Monad m => (forall d. Data d => d -> m d) -> ContentType -> m ContentType

gmapMp :: MonadPlus m => (forall d. Data d => d -> m d) -> ContentType -> m ContentType

gmapMo :: MonadPlus m => (forall d. Data d => d -> m d) -> ContentType -> m ContentType

Ord 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

Read ContentType

Methods

readsPrec :: Int -> ReadS ContentType

readList :: ReadS [ContentType]

readPrec :: ReadPrec ContentType

readListPrec :: ReadPrec [ContentType]

Show ContentType

Methods

showsPrec :: Int -> ContentType -> ShowS

show :: ContentType -> String

showList :: [ContentType] -> ShowS

Generic ContentType

Associated Types

type Rep ContentType :: * -> *

Methods

from :: ContentType -> Rep ContentType x

to :: Rep ContentType x -> ContentType

Hashable ContentType

Methods

hashWithSalt :: Int -> ContentType -> Int

hash :: ContentType -> Int

ToJSON ContentType

Methods

toJSON :: ContentType -> Value

toEncoding :: ContentType -> Encoding

toJSONList :: [ContentType] -> Value

toEncodingList :: [ContentType] -> Encoding

NFData ContentType

Methods

rnf :: ContentType -> ()

ToHeader ContentType

Methods

toHeader :: HeaderName -> ContentType -> [Header]

ToQuery ContentType

Methods

toQuery :: ContentType -> QueryString

ToByteString ContentType

Methods

toBS :: ContentType -> ByteString

FromText ContentType

Methods

parser :: Parser ContentType

ToText ContentType

Methods

toText :: ContentType -> Text

type Rep ContentType

type Rep ContentType = D1 (MetaData "ContentType" "Network.AWS.CloudSearchDomains.Types.Sum" "amazonka-cloudsearch-domains-1.4.5-1i0V9nIH6kwCncgjgJLojl" False) ((:+:) (C1 (MetaCons "ApplicationJSON" PrefixI False) U1) (C1 (MetaCons "ApplicationXML" PrefixI False) U1))

QueryParser

data QueryParser

Constructors

Dismax

Lucene

Simple

Structured

Instances

Bounded QueryParser

Methods

minBound :: QueryParser

maxBound :: QueryParser

Enum QueryParser

Methods

succ :: QueryParser -> QueryParser

pred :: QueryParser -> QueryParser

toEnum :: Int -> QueryParser

fromEnum :: QueryParser -> Int

enumFrom :: QueryParser -> [QueryParser]

enumFromThen :: QueryParser -> QueryParser -> [QueryParser]

enumFromTo :: QueryParser -> QueryParser -> [QueryParser]

enumFromThenTo :: QueryParser -> QueryParser -> QueryParser -> [QueryParser]

Eq QueryParser

Methods

(==) :: QueryParser -> QueryParser -> Bool

(/=) :: QueryParser -> QueryParser -> Bool

Data QueryParser

Methods

gfoldl :: (forall d b. Data d => c (d -> b) -> d -> c b) -> (forall g. g -> c g) -> QueryParser -> c QueryParser

gunfold :: (forall b r. Data b => c (b -> r) -> c r) -> (forall r. r -> c r) -> Constr -> c QueryParser

toConstr :: QueryParser -> Constr

dataTypeOf :: QueryParser -> DataType

dataCast1 :: Typeable (* -> *) t => (forall d. Data d => c (t d)) -> Maybe (c QueryParser)

dataCast2 :: Typeable (* -> * -> *) t => (forall d e. (Data d, Data e) => c (t d e)) -> Maybe (c QueryParser)

gmapT :: (forall b. Data b => b -> b) -> QueryParser -> QueryParser

gmapQl :: (r -> r' -> r) -> r -> (forall d. Data d => d -> r') -> QueryParser -> r

gmapQr :: (r' -> r -> r) -> r -> (forall d. Data d => d -> r') -> QueryParser -> r

gmapQ :: (forall d. Data d => d -> u) -> QueryParser -> [u]

gmapQi :: Int -> (forall d. Data d => d -> u) -> QueryParser -> u

gmapM :: Monad m => (forall d. Data d => d -> m d) -> QueryParser -> m QueryParser

gmapMp :: MonadPlus m => (forall d. Data d => d -> m d) -> QueryParser -> m QueryParser

gmapMo :: MonadPlus m => (forall d. Data d => d -> m d) -> QueryParser -> m QueryParser

Ord 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

Read QueryParser

Methods

readsPrec :: Int -> ReadS QueryParser

readList :: ReadS [QueryParser]

readPrec :: ReadPrec QueryParser

readListPrec :: ReadPrec [QueryParser]

Show QueryParser

Methods

showsPrec :: Int -> QueryParser -> ShowS

show :: QueryParser -> String

showList :: [QueryParser] -> ShowS

Generic QueryParser

Associated Types

type Rep QueryParser :: * -> *

Methods

from :: QueryParser -> Rep QueryParser x

to :: Rep QueryParser x -> QueryParser

Hashable QueryParser

Methods

hashWithSalt :: Int -> QueryParser -> Int

hash :: QueryParser -> Int

ToJSON QueryParser

Methods

toJSON :: QueryParser -> Value

toEncoding :: QueryParser -> Encoding

toJSONList :: [QueryParser] -> Value

toEncodingList :: [QueryParser] -> Encoding

NFData QueryParser

Methods

rnf :: QueryParser -> ()

ToHeader QueryParser

Methods

toHeader :: HeaderName -> QueryParser -> [Header]

ToQuery QueryParser

Methods

toQuery :: QueryParser -> QueryString

ToByteString QueryParser

Methods

toBS :: QueryParser -> ByteString

FromText QueryParser

Methods

parser :: Parser QueryParser

ToText QueryParser

Methods

toText :: QueryParser -> Text

type Rep QueryParser

type Rep QueryParser = D1 (MetaData "QueryParser" "Network.AWS.CloudSearchDomains.Types.Sum" "amazonka-cloudsearch-domains-1.4.5-1i0V9nIH6kwCncgjgJLojl" False) ((:+:) ((:+:) (C1 (MetaCons "Dismax" PrefixI False) U1) (C1 (MetaCons "Lucene" PrefixI False) U1)) ((:+:) (C1 (MetaCons "Simple" PrefixI False) U1) (C1 (MetaCons "Structured" PrefixI False) U1)))

Bucket

data Bucket

A container for facet information.

See: bucket smart constructor.

Instances

Eq Bucket

Methods

(==) :: Bucket -> Bucket -> Bool

(/=) :: Bucket -> Bucket -> Bool

Data Bucket

Methods

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

Methods

readsPrec :: Int -> ReadS Bucket

readList :: ReadS [Bucket]

readPrec :: ReadPrec Bucket

readListPrec :: ReadPrec [Bucket]

Show Bucket

Methods

showsPrec :: Int -> Bucket -> ShowS

show :: Bucket -> String

showList :: [Bucket] -> ShowS

Generic Bucket

Associated Types

type Rep Bucket :: * -> *

Methods

from :: Bucket -> Rep Bucket x

to :: Rep Bucket x -> Bucket

Hashable Bucket

Methods

hashWithSalt :: Int -> Bucket -> Int

hash :: Bucket -> Int

FromJSON Bucket

Methods

parseJSON :: Value -> Parser Bucket

parseJSONList :: Value -> Parser [Bucket]

NFData Bucket

Methods

rnf :: Bucket -> ()

type Rep Bucket

type Rep Bucket = D1 (MetaData "Bucket" "Network.AWS.CloudSearchDomains.Types.Product" "amazonka-cloudsearch-domains-1.4.5-1i0V9nIH6kwCncgjgJLojl" False) (C1 (MetaCons "Bucket'" PrefixI True) ((:*:) (S1 (MetaSel (Just Symbol "_bValue") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 (Maybe Text))) (S1 (MetaSel (Just Symbol "_bCount") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 (Maybe Integer)))))

bucket :: Bucket

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

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

• bValue - The facet value being counted.
• bCount - The number of hits that contain the facet value in the specified facet field.

bValue :: Lens' Bucket (Maybe Text)

The facet value being counted.

bCount :: Lens' Bucket (Maybe Integer)

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

BucketInfo

data BucketInfo

A container for the calculated facet values and counts.

See: bucketInfo smart constructor.

Instances

Eq BucketInfo

Methods

(==) :: BucketInfo -> BucketInfo -> Bool

(/=) :: BucketInfo -> BucketInfo -> Bool

Data BucketInfo

Methods

gfoldl :: (forall d b. Data d => c (d -> b) -> d -> c b) -> (forall g. g -> c g) -> BucketInfo -> c BucketInfo

gunfold :: (forall b r. Data b => c (b -> r) -> c r) -> (forall r. r -> c r) -> Constr -> c BucketInfo

toConstr :: BucketInfo -> Constr

dataTypeOf :: BucketInfo -> DataType

dataCast1 :: Typeable (* -> *) t => (forall d. Data d => c (t d)) -> Maybe (c BucketInfo)

dataCast2 :: Typeable (* -> * -> *) t => (forall d e. (Data d, Data e) => c (t d e)) -> Maybe (c BucketInfo)

gmapT :: (forall b. Data b => b -> b) -> BucketInfo -> BucketInfo

gmapQl :: (r -> r' -> r) -> r -> (forall d. Data d => d -> r') -> BucketInfo -> r

gmapQr :: (r' -> r -> r) -> r -> (forall d. Data d => d -> r') -> BucketInfo -> r

gmapQ :: (forall d. Data d => d -> u) -> BucketInfo -> [u]

gmapQi :: Int -> (forall d. Data d => d -> u) -> BucketInfo -> u

gmapM :: Monad m => (forall d. Data d => d -> m d) -> BucketInfo -> m BucketInfo

gmapMp :: MonadPlus m => (forall d. Data d => d -> m d) -> BucketInfo -> m BucketInfo

gmapMo :: MonadPlus m => (forall d. Data d => d -> m d) -> BucketInfo -> m BucketInfo

Read BucketInfo

Methods

readsPrec :: Int -> ReadS BucketInfo

readList :: ReadS [BucketInfo]

readPrec :: ReadPrec BucketInfo

readListPrec :: ReadPrec [BucketInfo]

Show BucketInfo

Methods

showsPrec :: Int -> BucketInfo -> ShowS

show :: BucketInfo -> String

showList :: [BucketInfo] -> ShowS

Generic BucketInfo

Associated Types

type Rep BucketInfo :: * -> *

Methods

from :: BucketInfo -> Rep BucketInfo x

to :: Rep BucketInfo x -> BucketInfo

Hashable BucketInfo

Methods

hashWithSalt :: Int -> BucketInfo -> Int

hash :: BucketInfo -> Int

FromJSON BucketInfo

Methods

parseJSON :: Value -> Parser BucketInfo

parseJSONList :: Value -> Parser [BucketInfo]

NFData BucketInfo

Methods

rnf :: BucketInfo -> ()

type Rep BucketInfo

type Rep BucketInfo = D1 (MetaData "BucketInfo" "Network.AWS.CloudSearchDomains.Types.Product" "amazonka-cloudsearch-domains-1.4.5-1i0V9nIH6kwCncgjgJLojl" True) (C1 (MetaCons "BucketInfo'" PrefixI True) (S1 (MetaSel (Just Symbol "_biBuckets") NoSourceUnpackedness NoSourceStrictness DecidedLazy) (Rec0 (Maybe [Bucket]))))

bucketInfo :: BucketInfo

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.

biBuckets :: Lens' BucketInfo [Bucket]

A list of the calculated facet values and counts.

DocumentServiceWarning

data DocumentServiceWarning

A warning returned by the document service when an issue is discovered while processing an upload request.

See: documentServiceWarning smart constructor.

Instances

Eq DocumentServiceWarning

Methods

(==) :: DocumentServiceWarning -> DocumentServiceWarning -> Bool

(/=) :: DocumentServiceWarning -> DocumentServiceWarning -> Bool

Data DocumentServiceWarning

Methods

gfoldl :: (forall d b. Data d => c (d -> b) -> d -> c b) -> (forall g. g -> c g) -> DocumentServiceWarning -> c DocumentServiceWarning

gunfold :: (forall b r. Data b => c (b -> r) -> c r) -> (forall r. r -> c r) -> Constr -> c DocumentServiceWarning

toConstr :: DocumentServiceWarning -> Constr

dataTypeOf :: DocumentServiceWarning -> DataType

dataCast1 :: Typeable (* -> *) t => (forall d. Data d => c (t d)) -> Maybe (c DocumentServiceWarning)

dataCast2 :: Typeable (* -> * -> *) t => (forall d e. (Data d, Data e) => c (t d e)) -> Maybe (c DocumentServiceWarning)

gmapT :: (forall b. Data b => b -> b) -> DocumentServiceWarning -> DocumentServiceWarning

gmapQl :: (r -> r' -> r) -> r -> (forall d. Data d => d -> r') -> DocumentServiceWarning -> r

gmapQr :: (r' -> r -> r) -> r -> (forall d. Data d => d -> r') -> DocumentServiceWarning -> r

gmapQ :: (forall d. Data d => d -> u) -> DocumentServiceWarning -> [u]

gmapQi :: Int -> (forall d. Data d => d -> u) -> DocumentServiceWarning -> u

gmapM :: Monad m => (forall d. Data d => d -> m d) -> DocumentServiceWarning -> m DocumentServiceWarning

gmapMp :: MonadPlus m => (forall d. Data d => d -> m d) -> DocumentServiceWarning -> m DocumentServiceWarning

gmapMo :: MonadPlus m => (forall d. Data d => d -> m d) -> DocumentServiceWarning -> m DocumentServiceWarning

Read DocumentServiceWarning

Methods

readsPrec :: Int -> ReadS DocumentServiceWarning

readList :: ReadS [DocumentServiceWarning]

readPrec :: ReadPrec DocumentServiceWarning

readListPrec :: ReadPrec [DocumentServiceWarning]

Show DocumentServiceWarning

Methods

showsPrec :: Int -> DocumentServiceWarning -> ShowS

show :: DocumentServiceWarning -> String

showList :: [DocumentServiceWarning] -> ShowS

Generic DocumentServiceWarning

Associated Types

type Rep DocumentServiceWarning :: * -> *

Methods

from :: DocumentServiceWarning -> Rep DocumentServiceWarning x

to :: Rep DocumentServiceWarning x -> DocumentServiceWarning

Hashable DocumentServiceWarning

Methods

hashWithSalt :: Int -> DocumentServiceWarning -> Int

hash :: DocumentServiceWarning -> Int

FromJSON DocumentServiceWarning

Methods

parseJSON :: Value -> Parser DocumentServiceWarning

parseJSONList :: Value -> Parser [DocumentServiceWarning]

NFData DocumentServiceWarning

Methods

rnf :: DocumentServiceWarning -> ()

type Rep DocumentServiceWarning

type Rep DocumentServiceWarning = D1 (MetaData "DocumentServiceWarning" "Network.AWS.CloudSearchDomains.Types.Product" "amazonka-cloudsearch-domains-1.4.5-1i0V9nIH6kwCncgjgJLojl" True) (C1 (MetaCons "DocumentServiceWarning'" PrefixI True) (S1 (MetaSel (Just Symbol "_dswMessage") NoSourceUnpackedness NoSourceStrictness DecidedLazy) (Rec0 (Maybe Text))))

documentServiceWarning :: DocumentServiceWarning

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)

The description for a warning returned by the document service.

FieldStats

data FieldStats

The statistics for a field calculated in the request.

See: fieldStats smart constructor.

Instances

Eq FieldStats

Methods

(==) :: FieldStats -> FieldStats -> Bool

(/=) :: FieldStats -> FieldStats -> Bool

Data FieldStats

Methods

gfoldl :: (forall d b. Data d => c (d -> b) -> d -> c b) -> (forall g. g -> c g) -> FieldStats -> c FieldStats

gunfold :: (forall b r. Data b => c (b -> r) -> c r) -> (forall r. r -> c r) -> Constr -> c FieldStats

toConstr :: FieldStats -> Constr

dataTypeOf :: FieldStats -> DataType

dataCast1 :: Typeable (* -> *) t => (forall d. Data d => c (t d)) -> Maybe (c FieldStats)

dataCast2 :: Typeable (* -> * -> *) t => (forall d e. (Data d, Data e) => c (t d e)) -> Maybe (c FieldStats)

gmapT :: (forall b. Data b => b -> b) -> FieldStats -> FieldStats

gmapQl :: (r -> r' -> r) -> r -> (forall d. Data d => d -> r') -> FieldStats -> r

gmapQr :: (r' -> r -> r) -> r -> (forall d. Data d => d -> r') -> FieldStats -> r

gmapQ :: (forall d. Data d => d -> u) -> FieldStats -> [u]

gmapQi :: Int -> (forall d. Data d => d -> u) -> FieldStats -> u

gmapM :: Monad m => (forall d. Data d => d -> m d) -> FieldStats -> m FieldStats

gmapMp :: MonadPlus m => (forall d. Data d => d -> m d) -> FieldStats -> m FieldStats

gmapMo :: MonadPlus m => (forall d. Data d => d -> m d) -> FieldStats -> m FieldStats

Read FieldStats

Methods

readsPrec :: Int -> ReadS FieldStats

readList :: ReadS [FieldStats]

readPrec :: ReadPrec FieldStats

readListPrec :: ReadPrec [FieldStats]

Show FieldStats

Methods

showsPrec :: Int -> FieldStats -> ShowS

show :: FieldStats -> String

showList :: [FieldStats] -> ShowS

Generic FieldStats

Associated Types

type Rep FieldStats :: * -> *

Methods

from :: FieldStats -> Rep FieldStats x

to :: Rep FieldStats x -> FieldStats

Hashable FieldStats

Methods

hashWithSalt :: Int -> FieldStats -> Int

hash :: FieldStats -> Int

FromJSON FieldStats

Methods

parseJSON :: Value -> Parser FieldStats

parseJSONList :: Value -> Parser [FieldStats]

NFData FieldStats

Methods

rnf :: FieldStats -> ()

type Rep FieldStats

type Rep FieldStats = D1 (MetaData "FieldStats" "Network.AWS.CloudSearchDomains.Types.Product" "amazonka-cloudsearch-domains-1.4.5-1i0V9nIH6kwCncgjgJLojl" False) (C1 (MetaCons "FieldStats'" PrefixI True) ((:*:) ((:*:) ((:*:) (S1 (MetaSel (Just Symbol "_fsMax") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 (Maybe Text))) (S1 (MetaSel (Just Symbol "_fsMean") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 (Maybe Text)))) ((:*:) (S1 (MetaSel (Just Symbol "_fsCount") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 (Maybe Integer))) (S1 (MetaSel (Just Symbol "_fsMissing") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 (Maybe Integer))))) ((:*:) ((:*:) (S1 (MetaSel (Just Symbol "_fsStddev") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 (Maybe Double))) (S1 (MetaSel (Just Symbol "_fsMin") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 (Maybe Text)))) ((:*:) (S1 (MetaSel (Just Symbol "_fsSumOfSquares") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 (Maybe Double))) (S1 (MetaSel (Just Symbol "_fsSum") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 (Maybe Double)))))))

fieldStats :: FieldStats

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 , 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 - 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 - 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 , 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 - 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)

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)

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)

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

fsMissing :: Lens' FieldStats (Maybe Integer)

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

fsStddev :: Lens' FieldStats (Maybe Double)

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

fsMin :: Lens' FieldStats (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.

fsSumOfSquares :: Lens' FieldStats (Maybe Double)

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

fsSum :: Lens' FieldStats (Maybe Double)

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

Hit

data Hit

Information about a document that matches the search request.

See: hit smart constructor.

Instances

Eq Hit

Methods

(==) :: Hit -> Hit -> Bool

(/=) :: Hit -> Hit -> Bool

Data Hit

Methods

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

toConstr :: Hit -> Constr

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

Methods

readsPrec :: Int -> ReadS Hit

readList :: ReadS [Hit]

readPrec :: ReadPrec Hit

readListPrec :: ReadPrec [Hit]

Show Hit

Methods

showsPrec :: Int -> Hit -> ShowS

show :: Hit -> String

showList :: [Hit] -> ShowS

Generic Hit

Associated Types

type Rep Hit :: * -> *

Methods

from :: Hit -> Rep Hit x

to :: Rep Hit x -> Hit

Hashable Hit

Methods

hashWithSalt :: Int -> Hit -> Int

hash :: Hit -> Int

FromJSON Hit

Methods

parseJSON :: Value -> Parser Hit

parseJSONList :: Value -> Parser [Hit]

NFData Hit

Methods

rnf :: Hit -> ()

type Rep Hit

type Rep Hit = D1 (MetaData "Hit" "Network.AWS.CloudSearchDomains.Types.Product" "amazonka-cloudsearch-domains-1.4.5-1i0V9nIH6kwCncgjgJLojl" False) (C1 (MetaCons "Hit'" PrefixI True) ((:*:) ((:*:) (S1 (MetaSel (Just Symbol "_hitExprs") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 (Maybe (Map Text Text)))) (S1 (MetaSel (Just Symbol "_hitId") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 (Maybe Text)))) ((:*:) (S1 (MetaSel (Just Symbol "_hitHighlights") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 (Maybe (Map Text Text)))) (S1 (MetaSel (Just Symbol "_hitFields") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 (Maybe (Map Text [Text])))))))

hit :: Hit

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)

The expressions returned from a document that matches the search request.

hitId :: Lens' Hit (Maybe Text)

The document ID of a document that matches the search request.

hitHighlights :: Lens' Hit (HashMap Text Text)

The highlights returned from a document that matches the search request.

hitFields :: Lens' Hit (HashMap Text [Text])

The fields returned from a document that matches the search request.

Hits

data Hits

The collection of documents that match the search request.

See: hits smart constructor.

Instances

Eq Hits

Methods

(==) :: Hits -> Hits -> Bool

(/=) :: Hits -> Hits -> Bool

Data Hits

Methods

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

toConstr :: Hits -> Constr

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

Methods

readsPrec :: Int -> ReadS Hits

readList :: ReadS [Hits]

readPrec :: ReadPrec Hits

readListPrec :: ReadPrec [Hits]

Show Hits

Methods

showsPrec :: Int -> Hits -> ShowS

show :: Hits -> String

showList :: [Hits] -> ShowS

Generic Hits

Associated Types

type Rep Hits :: * -> *

Methods

from :: Hits -> Rep Hits x

to :: Rep Hits x -> Hits

Hashable Hits

Methods

hashWithSalt :: Int -> Hits -> Int

hash :: Hits -> Int

FromJSON Hits

Methods

parseJSON :: Value -> Parser Hits

parseJSONList :: Value -> Parser [Hits]

NFData Hits

Methods

rnf :: Hits -> ()

type Rep Hits

type Rep Hits = D1 (MetaData "Hits" "Network.AWS.CloudSearchDomains.Types.Product" "amazonka-cloudsearch-domains-1.4.5-1i0V9nIH6kwCncgjgJLojl" False) (C1 (MetaCons "Hits'" PrefixI True) ((:*:) ((:*:) (S1 (MetaSel (Just Symbol "_hCursor") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 (Maybe Text))) (S1 (MetaSel (Just Symbol "_hHit") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 (Maybe [Hit])))) ((:*:) (S1 (MetaSel (Just Symbol "_hStart") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 (Maybe Integer))) (S1 (MetaSel (Just Symbol "_hFound") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 (Maybe Integer))))))

hits :: Hits

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)

A cursor that can be used to retrieve the next set of matching documents when you want to page through a large result set.

hHit :: Lens' Hits [Hit]

A document that matches the search request.

hStart :: Lens' Hits (Maybe Integer)

The index of the first matching document.

hFound :: Lens' Hits (Maybe Integer)

The total number of documents that match the search request.

SearchStatus

data SearchStatus

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

See: searchStatus smart constructor.

Instances

Eq SearchStatus

Methods

(==) :: SearchStatus -> SearchStatus -> Bool

(/=) :: SearchStatus -> SearchStatus -> Bool

Data SearchStatus

Methods

gfoldl :: (forall d b. Data d => c (d -> b) -> d -> c b) -> (forall g. g -> c g) -> SearchStatus -> c SearchStatus

gunfold :: (forall b r. Data b => c (b -> r) -> c r) -> (forall r. r -> c r) -> Constr -> c SearchStatus

toConstr :: SearchStatus -> Constr

dataTypeOf :: SearchStatus -> DataType

dataCast1 :: Typeable (* -> *) t => (forall d. Data d => c (t d)) -> Maybe (c SearchStatus)

dataCast2 :: Typeable (* -> * -> *) t => (forall d e. (Data d, Data e) => c (t d e)) -> Maybe (c SearchStatus)

gmapT :: (forall b. Data b => b -> b) -> SearchStatus -> SearchStatus

gmapQl :: (r -> r' -> r) -> r -> (forall d. Data d => d -> r') -> SearchStatus -> r

gmapQr :: (r' -> r -> r) -> r -> (forall d. Data d => d -> r') -> SearchStatus -> r

gmapQ :: (forall d. Data d => d -> u) -> SearchStatus -> [u]

gmapQi :: Int -> (forall d. Data d => d -> u) -> SearchStatus -> u

gmapM :: Monad m => (forall d. Data d => d -> m d) -> SearchStatus -> m SearchStatus

gmapMp :: MonadPlus m => (forall d. Data d => d -> m d) -> SearchStatus -> m SearchStatus

gmapMo :: MonadPlus m => (forall d. Data d => d -> m d) -> SearchStatus -> m SearchStatus

Read SearchStatus

Methods

readsPrec :: Int -> ReadS SearchStatus

readList :: ReadS [SearchStatus]

readPrec :: ReadPrec SearchStatus

readListPrec :: ReadPrec [SearchStatus]

Show SearchStatus

Methods

showsPrec :: Int -> SearchStatus -> ShowS

show :: SearchStatus -> String

showList :: [SearchStatus] -> ShowS

Generic SearchStatus

Associated Types

type Rep SearchStatus :: * -> *

Methods

from :: SearchStatus -> Rep SearchStatus x

to :: Rep SearchStatus x -> SearchStatus

Hashable SearchStatus

Methods

hashWithSalt :: Int -> SearchStatus -> Int

hash :: SearchStatus -> Int

FromJSON SearchStatus

Methods

parseJSON :: Value -> Parser SearchStatus

parseJSONList :: Value -> Parser [SearchStatus]

NFData SearchStatus

Methods

rnf :: SearchStatus -> ()

type Rep SearchStatus

type Rep SearchStatus = D1 (MetaData "SearchStatus" "Network.AWS.CloudSearchDomains.Types.Product" "amazonka-cloudsearch-domains-1.4.5-1i0V9nIH6kwCncgjgJLojl" False) (C1 (MetaCons "SearchStatus'" PrefixI True) ((:*:) (S1 (MetaSel (Just Symbol "_sRid") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 (Maybe Text))) (S1 (MetaSel (Just Symbol "_sTimems") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 (Maybe Integer)))))

searchStatus :: SearchStatus

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

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

• sRid - The encrypted resource ID for the request.
• sTimems - How long it took to process the request, in milliseconds.

sRid :: Lens' SearchStatus (Maybe Text)

The encrypted resource ID for the request.

sTimems :: Lens' SearchStatus (Maybe Integer)

How long it took to process the request, in milliseconds.

SuggestModel

data SuggestModel

Container for the suggestion information returned in a SuggestResponse .

See: suggestModel smart constructor.

Instances

Eq SuggestModel

Methods

(==) :: SuggestModel -> SuggestModel -> Bool

(/=) :: SuggestModel -> SuggestModel -> Bool

Data SuggestModel

Methods

gfoldl :: (forall d b. Data d => c (d -> b) -> d -> c b) -> (forall g. g -> c g) -> SuggestModel -> c SuggestModel

gunfold :: (forall b r. Data b => c (b -> r) -> c r) -> (forall r. r -> c r) -> Constr -> c SuggestModel

toConstr :: SuggestModel -> Constr

dataTypeOf :: SuggestModel -> DataType

dataCast1 :: Typeable (* -> *) t => (forall d. Data d => c (t d)) -> Maybe (c SuggestModel)

dataCast2 :: Typeable (* -> * -> *) t => (forall d e. (Data d, Data e) => c (t d e)) -> Maybe (c SuggestModel)

gmapT :: (forall b. Data b => b -> b) -> SuggestModel -> SuggestModel

gmapQl :: (r -> r' -> r) -> r -> (forall d. Data d => d -> r') -> SuggestModel -> r

gmapQr :: (r' -> r -> r) -> r -> (forall d. Data d => d -> r') -> SuggestModel -> r

gmapQ :: (forall d. Data d => d -> u) -> SuggestModel -> [u]

gmapQi :: Int -> (forall d. Data d => d -> u) -> SuggestModel -> u

gmapM :: Monad m => (forall d. Data d => d -> m d) -> SuggestModel -> m SuggestModel

gmapMp :: MonadPlus m => (forall d. Data d => d -> m d) -> SuggestModel -> m SuggestModel

gmapMo :: MonadPlus m => (forall d. Data d => d -> m d) -> SuggestModel -> m SuggestModel

Read SuggestModel

Methods

readsPrec :: Int -> ReadS SuggestModel

readList :: ReadS [SuggestModel]

readPrec :: ReadPrec SuggestModel

readListPrec :: ReadPrec [SuggestModel]

Show SuggestModel

Methods

showsPrec :: Int -> SuggestModel -> ShowS

show :: SuggestModel -> String

showList :: [SuggestModel] -> ShowS

Generic SuggestModel

Associated Types

type Rep SuggestModel :: * -> *

Methods

from :: SuggestModel -> Rep SuggestModel x

to :: Rep SuggestModel x -> SuggestModel

Hashable SuggestModel

Methods

hashWithSalt :: Int -> SuggestModel -> Int

hash :: SuggestModel -> Int

FromJSON SuggestModel

Methods

parseJSON :: Value -> Parser SuggestModel

parseJSONList :: Value -> Parser [SuggestModel]

NFData SuggestModel

Methods

rnf :: SuggestModel -> ()

type Rep SuggestModel

type Rep SuggestModel = D1 (MetaData "SuggestModel" "Network.AWS.CloudSearchDomains.Types.Product" "amazonka-cloudsearch-domains-1.4.5-1i0V9nIH6kwCncgjgJLojl" False) (C1 (MetaCons "SuggestModel'" PrefixI True) ((:*:) (S1 (MetaSel (Just Symbol "_smFound") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 (Maybe Integer))) ((:*:) (S1 (MetaSel (Just Symbol "_smSuggestions") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 (Maybe [SuggestionMatch]))) (S1 (MetaSel (Just Symbol "_smQuery") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 (Maybe Text))))))

suggestModel :: SuggestModel

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)

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

smSuggestions :: Lens' SuggestModel [SuggestionMatch]

The documents that match the query string.

smQuery :: Lens' SuggestModel (Maybe Text)

The query string specified in the suggest request.

SuggestStatus

data SuggestStatus

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

See: suggestStatus smart constructor.

Instances

Eq SuggestStatus

Methods

(==) :: SuggestStatus -> SuggestStatus -> Bool

(/=) :: SuggestStatus -> SuggestStatus -> Bool

Data SuggestStatus

Methods

gfoldl :: (forall d b. Data d => c (d -> b) -> d -> c b) -> (forall g. g -> c g) -> SuggestStatus -> c SuggestStatus

gunfold :: (forall b r. Data b => c (b -> r) -> c r) -> (forall r. r -> c r) -> Constr -> c SuggestStatus

toConstr :: SuggestStatus -> Constr

dataTypeOf :: SuggestStatus -> DataType

dataCast1 :: Typeable (* -> *) t => (forall d. Data d => c (t d)) -> Maybe (c SuggestStatus)

dataCast2 :: Typeable (* -> * -> *) t => (forall d e. (Data d, Data e) => c (t d e)) -> Maybe (c SuggestStatus)

gmapT :: (forall b. Data b => b -> b) -> SuggestStatus -> SuggestStatus

gmapQl :: (r -> r' -> r) -> r -> (forall d. Data d => d -> r') -> SuggestStatus -> r

gmapQr :: (r' -> r -> r) -> r -> (forall d. Data d => d -> r') -> SuggestStatus -> r

gmapQ :: (forall d. Data d => d -> u) -> SuggestStatus -> [u]

gmapQi :: Int -> (forall d. Data d => d -> u) -> SuggestStatus -> u

gmapM :: Monad m => (forall d. Data d => d -> m d) -> SuggestStatus -> m SuggestStatus

gmapMp :: MonadPlus m => (forall d. Data d => d -> m d) -> SuggestStatus -> m SuggestStatus

gmapMo :: MonadPlus m => (forall d. Data d => d -> m d) -> SuggestStatus -> m SuggestStatus

Read SuggestStatus

Methods

readsPrec :: Int -> ReadS SuggestStatus

readList :: ReadS [SuggestStatus]

readPrec :: ReadPrec SuggestStatus

readListPrec :: ReadPrec [SuggestStatus]

Show SuggestStatus

Methods

showsPrec :: Int -> SuggestStatus -> ShowS

show :: SuggestStatus -> String

showList :: [SuggestStatus] -> ShowS

Generic SuggestStatus

Associated Types

type Rep SuggestStatus :: * -> *

Methods

from :: SuggestStatus -> Rep SuggestStatus x

to :: Rep SuggestStatus x -> SuggestStatus

Hashable SuggestStatus

Methods

hashWithSalt :: Int -> SuggestStatus -> Int

hash :: SuggestStatus -> Int

FromJSON SuggestStatus

Methods

parseJSON :: Value -> Parser SuggestStatus

parseJSONList :: Value -> Parser [SuggestStatus]

NFData SuggestStatus

Methods

rnf :: SuggestStatus -> ()

type Rep SuggestStatus

type Rep SuggestStatus = D1 (MetaData "SuggestStatus" "Network.AWS.CloudSearchDomains.Types.Product" "amazonka-cloudsearch-domains-1.4.5-1i0V9nIH6kwCncgjgJLojl" False) (C1 (MetaCons "SuggestStatus'" PrefixI True) ((:*:) (S1 (MetaSel (Just Symbol "_ssRid") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 (Maybe Text))) (S1 (MetaSel (Just Symbol "_ssTimems") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 (Maybe Integer)))))

suggestStatus :: SuggestStatus

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

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

• ssRid - The encrypted resource ID for the request.
• ssTimems - How long it took to process the request, in milliseconds.

ssRid :: Lens' SuggestStatus (Maybe Text)

The encrypted resource ID for the request.

ssTimems :: Lens' SuggestStatus (Maybe Integer)

How long it took to process the request, in milliseconds.

SuggestionMatch

data SuggestionMatch

An autocomplete suggestion that matches the query string specified in a SuggestRequest .

See: suggestionMatch smart constructor.

Instances

Eq SuggestionMatch

Methods

(==) :: SuggestionMatch -> SuggestionMatch -> Bool

(/=) :: SuggestionMatch -> SuggestionMatch -> Bool

Data SuggestionMatch

Methods

gfoldl :: (forall d b. Data d => c (d -> b) -> d -> c b) -> (forall g. g -> c g) -> SuggestionMatch -> c SuggestionMatch

gunfold :: (forall b r. Data b => c (b -> r) -> c r) -> (forall r. r -> c r) -> Constr -> c SuggestionMatch

toConstr :: SuggestionMatch -> Constr

dataTypeOf :: SuggestionMatch -> DataType

dataCast1 :: Typeable (* -> *) t => (forall d. Data d => c (t d)) -> Maybe (c SuggestionMatch)

dataCast2 :: Typeable (* -> * -> *) t => (forall d e. (Data d, Data e) => c (t d e)) -> Maybe (c SuggestionMatch)

gmapT :: (forall b. Data b => b -> b) -> SuggestionMatch -> SuggestionMatch

gmapQl :: (r -> r' -> r) -> r -> (forall d. Data d => d -> r') -> SuggestionMatch -> r

gmapQr :: (r' -> r -> r) -> r -> (forall d. Data d => d -> r') -> SuggestionMatch -> r

gmapQ :: (forall d. Data d => d -> u) -> SuggestionMatch -> [u]

gmapQi :: Int -> (forall d. Data d => d -> u) -> SuggestionMatch -> u

gmapM :: Monad m => (forall d. Data d => d -> m d) -> SuggestionMatch -> m SuggestionMatch

gmapMp :: MonadPlus m => (forall d. Data d => d -> m d) -> SuggestionMatch -> m SuggestionMatch

gmapMo :: MonadPlus m => (forall d. Data d => d -> m d) -> SuggestionMatch -> m SuggestionMatch

Read SuggestionMatch

Methods

readsPrec :: Int -> ReadS SuggestionMatch

readList :: ReadS [SuggestionMatch]

readPrec :: ReadPrec SuggestionMatch

readListPrec :: ReadPrec [SuggestionMatch]

Show SuggestionMatch

Methods

showsPrec :: Int -> SuggestionMatch -> ShowS

show :: SuggestionMatch -> String

showList :: [SuggestionMatch] -> ShowS

Generic SuggestionMatch

Associated Types

type Rep SuggestionMatch :: * -> *

Methods

from :: SuggestionMatch -> Rep SuggestionMatch x

to :: Rep SuggestionMatch x -> SuggestionMatch

Hashable SuggestionMatch

Methods

hashWithSalt :: Int -> SuggestionMatch -> Int

hash :: SuggestionMatch -> Int

FromJSON SuggestionMatch

Methods

parseJSON :: Value -> Parser SuggestionMatch

parseJSONList :: Value -> Parser [SuggestionMatch]

NFData SuggestionMatch

Methods

rnf :: SuggestionMatch -> ()

type Rep SuggestionMatch

type Rep SuggestionMatch = D1 (MetaData "SuggestionMatch" "Network.AWS.CloudSearchDomains.Types.Product" "amazonka-cloudsearch-domains-1.4.5-1i0V9nIH6kwCncgjgJLojl" False) (C1 (MetaCons "SuggestionMatch'" PrefixI True) ((:*:) (S1 (MetaSel (Just Symbol "_smSuggestion") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 (Maybe Text))) ((:*:) (S1 (MetaSel (Just Symbol "_smScore") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 (Maybe Integer))) (S1 (MetaSel (Just Symbol "_smId") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 (Maybe Text))))))

suggestionMatch :: SuggestionMatch

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 the SuggestRequest .
• smScore - The relevance score of a suggested match.
• smId - The document ID of the suggested document.

smSuggestion :: Lens' SuggestionMatch (Maybe Text)

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

smScore :: Lens' SuggestionMatch (Maybe Integer)

The relevance score of a suggested match.

smId :: Lens' SuggestionMatch (Maybe Text)

The document ID of the suggested document.