libZSservicesZSamazonka-cloudsearch-domainsZSamazonka-cloudsearch-domains
Copyright(c) 2013-2021 Brendan Hay
LicenseMozilla Public License, v. 2.0.
MaintainerBrendan Hay <brendan.g.hay+amazonka@gmail.com>
Stabilityauto-generated
Portabilitynon-portable (GHC extensions)
Safe HaskellNone

Amazonka.CloudSearchDomains.Types

Description

 
Synopsis

Service Configuration

defaultService :: Service Source #

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

Errors

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

Information about any problems encountered while processing an upload request.

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

Information about any problems encountered while processing a search request.

ContentType

newtype ContentType Source #

Constructors

ContentType' 

Instances

Instances details
Eq ContentType Source # 
Instance details

Defined in Amazonka.CloudSearchDomains.Types.ContentType

Ord ContentType Source # 
Instance details

Defined in Amazonka.CloudSearchDomains.Types.ContentType

Read ContentType Source # 
Instance details

Defined in Amazonka.CloudSearchDomains.Types.ContentType

Show ContentType Source # 
Instance details

Defined in Amazonka.CloudSearchDomains.Types.ContentType

Generic ContentType Source # 
Instance details

Defined in Amazonka.CloudSearchDomains.Types.ContentType

Associated Types

type Rep ContentType :: Type -> Type #

NFData ContentType Source # 
Instance details

Defined in Amazonka.CloudSearchDomains.Types.ContentType

Methods

rnf :: ContentType -> () #

Hashable ContentType Source # 
Instance details

Defined in Amazonka.CloudSearchDomains.Types.ContentType

ToJSON ContentType Source # 
Instance details

Defined in Amazonka.CloudSearchDomains.Types.ContentType

ToJSONKey ContentType Source # 
Instance details

Defined in Amazonka.CloudSearchDomains.Types.ContentType

FromJSON ContentType Source # 
Instance details

Defined in Amazonka.CloudSearchDomains.Types.ContentType

FromJSONKey ContentType Source # 
Instance details

Defined in Amazonka.CloudSearchDomains.Types.ContentType

ToLog ContentType Source # 
Instance details

Defined in Amazonka.CloudSearchDomains.Types.ContentType

ToHeader ContentType Source # 
Instance details

Defined in Amazonka.CloudSearchDomains.Types.ContentType

ToQuery ContentType Source # 
Instance details

Defined in Amazonka.CloudSearchDomains.Types.ContentType

FromXML ContentType Source # 
Instance details

Defined in Amazonka.CloudSearchDomains.Types.ContentType

ToXML ContentType Source # 
Instance details

Defined in Amazonka.CloudSearchDomains.Types.ContentType

Methods

toXML :: ContentType -> XML #

ToByteString ContentType Source # 
Instance details

Defined in Amazonka.CloudSearchDomains.Types.ContentType

FromText ContentType Source # 
Instance details

Defined in Amazonka.CloudSearchDomains.Types.ContentType

ToText ContentType Source # 
Instance details

Defined in Amazonka.CloudSearchDomains.Types.ContentType

Methods

toText :: ContentType -> Text #

type Rep ContentType Source # 
Instance details

Defined in Amazonka.CloudSearchDomains.Types.ContentType

type Rep ContentType = D1 ('MetaData "ContentType" "Amazonka.CloudSearchDomains.Types.ContentType" "libZSservicesZSamazonka-cloudsearch-domainsZSamazonka-cloudsearch-domains" 'True) (C1 ('MetaCons "ContentType'" 'PrefixI 'True) (S1 ('MetaSel ('Just "fromContentType") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 Text)))

QueryParser

newtype QueryParser Source #

Constructors

QueryParser' 

Instances

Instances details
Eq QueryParser Source # 
Instance details

Defined in Amazonka.CloudSearchDomains.Types.QueryParser

Ord QueryParser Source # 
Instance details

Defined in Amazonka.CloudSearchDomains.Types.QueryParser

Read QueryParser Source # 
Instance details

Defined in Amazonka.CloudSearchDomains.Types.QueryParser

Show QueryParser Source # 
Instance details

Defined in Amazonka.CloudSearchDomains.Types.QueryParser

Generic QueryParser Source # 
Instance details

Defined in Amazonka.CloudSearchDomains.Types.QueryParser

Associated Types

type Rep QueryParser :: Type -> Type #

NFData QueryParser Source # 
Instance details

Defined in Amazonka.CloudSearchDomains.Types.QueryParser

Methods

rnf :: QueryParser -> () #

Hashable QueryParser Source # 
Instance details

Defined in Amazonka.CloudSearchDomains.Types.QueryParser

ToJSON QueryParser Source # 
Instance details

Defined in Amazonka.CloudSearchDomains.Types.QueryParser

ToJSONKey QueryParser Source # 
Instance details

Defined in Amazonka.CloudSearchDomains.Types.QueryParser

FromJSON QueryParser Source # 
Instance details

Defined in Amazonka.CloudSearchDomains.Types.QueryParser

FromJSONKey QueryParser Source # 
Instance details

Defined in Amazonka.CloudSearchDomains.Types.QueryParser

ToLog QueryParser Source # 
Instance details

Defined in Amazonka.CloudSearchDomains.Types.QueryParser

ToHeader QueryParser Source # 
Instance details

Defined in Amazonka.CloudSearchDomains.Types.QueryParser

ToQuery QueryParser Source # 
Instance details

Defined in Amazonka.CloudSearchDomains.Types.QueryParser

FromXML QueryParser Source # 
Instance details

Defined in Amazonka.CloudSearchDomains.Types.QueryParser

ToXML QueryParser Source # 
Instance details

Defined in Amazonka.CloudSearchDomains.Types.QueryParser

Methods

toXML :: QueryParser -> XML #

ToByteString QueryParser Source # 
Instance details

Defined in Amazonka.CloudSearchDomains.Types.QueryParser

FromText QueryParser Source # 
Instance details

Defined in Amazonka.CloudSearchDomains.Types.QueryParser

ToText QueryParser Source # 
Instance details

Defined in Amazonka.CloudSearchDomains.Types.QueryParser

Methods

toText :: QueryParser -> Text #

type Rep QueryParser Source # 
Instance details

Defined in Amazonka.CloudSearchDomains.Types.QueryParser

type Rep QueryParser = D1 ('MetaData "QueryParser" "Amazonka.CloudSearchDomains.Types.QueryParser" "libZSservicesZSamazonka-cloudsearch-domainsZSamazonka-cloudsearch-domains" '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

Instances

Instances details
Eq Bucket Source # 
Instance details

Defined in Amazonka.CloudSearchDomains.Types.Bucket

Methods

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

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

Read Bucket Source # 
Instance details

Defined in Amazonka.CloudSearchDomains.Types.Bucket

Show Bucket Source # 
Instance details

Defined in Amazonka.CloudSearchDomains.Types.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 #

NFData Bucket Source # 
Instance details

Defined in Amazonka.CloudSearchDomains.Types.Bucket

Methods

rnf :: Bucket -> () #

Hashable Bucket Source # 
Instance details

Defined in Amazonka.CloudSearchDomains.Types.Bucket

Methods

hashWithSalt :: Int -> Bucket -> Int #

hash :: Bucket -> Int #

FromJSON Bucket Source # 
Instance details

Defined in Amazonka.CloudSearchDomains.Types.Bucket

type Rep Bucket Source # 
Instance details

Defined in Amazonka.CloudSearchDomains.Types.Bucket

type Rep Bucket = D1 ('MetaData "Bucket" "Amazonka.CloudSearchDomains.Types.Bucket" "libZSservicesZSamazonka-cloudsearch-domainsZSamazonka-cloudsearch-domains" 'False) (C1 ('MetaCons "Bucket'" 'PrefixI 'True) (S1 ('MetaSel ('Just "value") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :*: S1 ('MetaSel ('Just "count") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Integer))))

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:value:Bucket', bucket_value - The facet value being counted.

$sel:count:Bucket', bucket_count - The number of hits that contain the facet value in the specified facet field.

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

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.

BucketInfo

data BucketInfo Source #

A container for the calculated facet values and counts.

See: newBucketInfo smart constructor.

Constructors

BucketInfo' 

Fields

Instances

Instances details
Eq BucketInfo Source # 
Instance details

Defined in Amazonka.CloudSearchDomains.Types.BucketInfo

Read BucketInfo Source # 
Instance details

Defined in Amazonka.CloudSearchDomains.Types.BucketInfo

Show BucketInfo Source # 
Instance details

Defined in Amazonka.CloudSearchDomains.Types.BucketInfo

Generic BucketInfo Source # 
Instance details

Defined in Amazonka.CloudSearchDomains.Types.BucketInfo

Associated Types

type Rep BucketInfo :: Type -> Type #

NFData BucketInfo Source # 
Instance details

Defined in Amazonka.CloudSearchDomains.Types.BucketInfo

Methods

rnf :: BucketInfo -> () #

Hashable BucketInfo Source # 
Instance details

Defined in Amazonka.CloudSearchDomains.Types.BucketInfo

FromJSON BucketInfo Source # 
Instance details

Defined in Amazonka.CloudSearchDomains.Types.BucketInfo

type Rep BucketInfo Source # 
Instance details

Defined in Amazonka.CloudSearchDomains.Types.BucketInfo

type Rep BucketInfo = D1 ('MetaData "BucketInfo" "Amazonka.CloudSearchDomains.Types.BucketInfo" "libZSservicesZSamazonka-cloudsearch-domainsZSamazonka-cloudsearch-domains" '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
Eq DocumentServiceWarning Source # 
Instance details

Defined in Amazonka.CloudSearchDomains.Types.DocumentServiceWarning

Read DocumentServiceWarning Source # 
Instance details

Defined in Amazonka.CloudSearchDomains.Types.DocumentServiceWarning

Show DocumentServiceWarning Source # 
Instance details

Defined in Amazonka.CloudSearchDomains.Types.DocumentServiceWarning

Generic DocumentServiceWarning Source # 
Instance details

Defined in Amazonka.CloudSearchDomains.Types.DocumentServiceWarning

Associated Types

type Rep DocumentServiceWarning :: Type -> Type #

NFData DocumentServiceWarning Source # 
Instance details

Defined in Amazonka.CloudSearchDomains.Types.DocumentServiceWarning

Methods

rnf :: DocumentServiceWarning -> () #

Hashable DocumentServiceWarning Source # 
Instance details

Defined in Amazonka.CloudSearchDomains.Types.DocumentServiceWarning

FromJSON DocumentServiceWarning Source # 
Instance details

Defined in Amazonka.CloudSearchDomains.Types.DocumentServiceWarning

type Rep DocumentServiceWarning Source # 
Instance details

Defined in Amazonka.CloudSearchDomains.Types.DocumentServiceWarning

type Rep DocumentServiceWarning = D1 ('MetaData "DocumentServiceWarning" "Amazonka.CloudSearchDomains.Types.DocumentServiceWarning" "libZSservicesZSamazonka-cloudsearch-domainsZSamazonka-cloudsearch-domains" '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

  • 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.

  • count :: Maybe Integer

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

  • 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.

  • 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.

  • sumOfSquares :: Maybe Double

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

  • sum :: Maybe Double

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

Instances

Instances details
Eq FieldStats Source # 
Instance details

Defined in Amazonka.CloudSearchDomains.Types.FieldStats

Read FieldStats Source # 
Instance details

Defined in Amazonka.CloudSearchDomains.Types.FieldStats

Show FieldStats Source # 
Instance details

Defined in Amazonka.CloudSearchDomains.Types.FieldStats

Generic FieldStats Source # 
Instance details

Defined in Amazonka.CloudSearchDomains.Types.FieldStats

Associated Types

type Rep FieldStats :: Type -> Type #

NFData FieldStats Source # 
Instance details

Defined in Amazonka.CloudSearchDomains.Types.FieldStats

Methods

rnf :: FieldStats -> () #

Hashable FieldStats Source # 
Instance details

Defined in Amazonka.CloudSearchDomains.Types.FieldStats

FromJSON FieldStats Source # 
Instance details

Defined in Amazonka.CloudSearchDomains.Types.FieldStats

type Rep FieldStats Source # 
Instance details

Defined in Amazonka.CloudSearchDomains.Types.FieldStats

newFieldStats :: FieldStats Source #

Create a value of FieldStats with all optional fields omitted.

Use generic-lens or optics to modify other optional fields.

The following record fields are available, with the corresponding lenses provided for backwards compatibility:

$sel:max:FieldStats', fieldStats_max - The maximum value found in the specified field in the result set.

If the field is numeric (int, int-array, double, or double-array), max is the string representation of a double-precision 64-bit floating point value. If the field is date or date-array, max is the string representation of a date with the format specified in IETF RFC3339: yyyy-mm-ddTHH:mm:ss.SSSZ.

$sel:mean:FieldStats', fieldStats_mean - The average of the values found in the specified field in the result set.

If the field is numeric (int, int-array, double, or double-array), mean is the string representation of a double-precision 64-bit floating point value. If the field is date or date-array, mean is the string representation of a date with the format specified in IETF RFC3339: yyyy-mm-ddTHH:mm:ss.SSSZ.

$sel:count:FieldStats', fieldStats_count - The number of documents that contain a value in the specified field in the result set.

$sel:missing:FieldStats', fieldStats_missing - The number of documents that do not contain a value in the specified field in the result set.

$sel:stddev:FieldStats', fieldStats_stddev - The standard deviation of the values in the specified field in the result set.

$sel:min:FieldStats', fieldStats_min - The minimum value found in the specified field in the result set.

If the field is numeric (int, int-array, double, or double-array), min is the string representation of a double-precision 64-bit floating point value. If the field is date or date-array, min is the string representation of a date with the format specified in IETF RFC3339: yyyy-mm-ddTHH:mm:ss.SSSZ.

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

$sel:sum:FieldStats', fieldStats_sum - The sum of the field values across the documents in the result set. null for date fields.

fieldStats_max :: Lens' FieldStats (Maybe Text) Source #

The maximum value found in the specified field in the result set.

If the field is numeric (int, int-array, double, or double-array), max is the string representation of a double-precision 64-bit floating point value. If the field is date or date-array, max is the string representation of a date with the format specified in IETF RFC3339: yyyy-mm-ddTHH:mm:ss.SSSZ.

fieldStats_mean :: Lens' FieldStats (Maybe Text) Source #

The average of the values found in the specified field in the result set.

If the field is numeric (int, int-array, double, or double-array), mean is the string representation of a double-precision 64-bit floating point value. If the field is date or date-array, mean is the string representation of a date with the format specified in IETF RFC3339: yyyy-mm-ddTHH:mm:ss.SSSZ.

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

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

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

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

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

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

fieldStats_min :: Lens' FieldStats (Maybe Text) Source #

The minimum value found in the specified field in the result set.

If the field is numeric (int, int-array, double, or double-array), min is the string representation of a double-precision 64-bit floating point value. If the field is date or date-array, min is the string representation of a date with the format specified in IETF RFC3339: yyyy-mm-ddTHH:mm:ss.SSSZ.

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

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

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

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

Hit

data Hit Source #

Information about a document that matches the search request.

See: newHit smart constructor.

Constructors

Hit' 

Fields

Instances

Instances details
Eq Hit Source # 
Instance details

Defined in Amazonka.CloudSearchDomains.Types.Hit

Methods

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

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

Read Hit Source # 
Instance details

Defined in Amazonka.CloudSearchDomains.Types.Hit

Show Hit Source # 
Instance details

Defined in Amazonka.CloudSearchDomains.Types.Hit

Methods

showsPrec :: Int -> Hit -> ShowS #

show :: Hit -> String #

showList :: [Hit] -> ShowS #

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 #

NFData Hit Source # 
Instance details

Defined in Amazonka.CloudSearchDomains.Types.Hit

Methods

rnf :: Hit -> () #

Hashable Hit Source # 
Instance details

Defined in Amazonka.CloudSearchDomains.Types.Hit

Methods

hashWithSalt :: Int -> Hit -> Int #

hash :: Hit -> Int #

FromJSON Hit Source # 
Instance details

Defined in Amazonka.CloudSearchDomains.Types.Hit

type Rep Hit Source # 
Instance details

Defined in Amazonka.CloudSearchDomains.Types.Hit

type Rep Hit = D1 ('MetaData "Hit" "Amazonka.CloudSearchDomains.Types.Hit" "libZSservicesZSamazonka-cloudsearch-domainsZSamazonka-cloudsearch-domains" 'False) (C1 ('MetaCons "Hit'" 'PrefixI 'True) ((S1 ('MetaSel ('Just "exprs") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe (HashMap Text Text))) :*: S1 ('MetaSel ('Just "id") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text))) :*: (S1 ('MetaSel ('Just "highlights") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe (HashMap Text Text))) :*: S1 ('MetaSel ('Just "fields") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe (HashMap Text [Text]))))))

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:id:Hit', hit_id - The document ID of a document that matches the search request.

$sel:highlights:Hit', hit_highlights - The highlights returned from a document that matches the search request.

$sel:fields:Hit', hit_fields - The fields returned from a document that matches the search request.

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

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

hit_id :: Lens' Hit (Maybe Text) Source #

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

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

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

hit_fields :: Lens' Hit (Maybe (HashMap Text [Text])) Source #

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

Hits

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.

  • hit :: Maybe [Hit]

    A document that matches the search request.

  • start :: Maybe Integer

    The index of the first matching document.

  • found :: Maybe Integer

    The total number of documents that match the search request.

Instances

Instances details
Eq Hits Source # 
Instance details

Defined in Amazonka.CloudSearchDomains.Types.Hits

Methods

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

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

Read Hits Source # 
Instance details

Defined in Amazonka.CloudSearchDomains.Types.Hits

Show Hits Source # 
Instance details

Defined in Amazonka.CloudSearchDomains.Types.Hits

Methods

showsPrec :: Int -> Hits -> ShowS #

show :: Hits -> String #

showList :: [Hits] -> ShowS #

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 #

NFData Hits Source # 
Instance details

Defined in Amazonka.CloudSearchDomains.Types.Hits

Methods

rnf :: Hits -> () #

Hashable Hits Source # 
Instance details

Defined in Amazonka.CloudSearchDomains.Types.Hits

Methods

hashWithSalt :: Int -> Hits -> Int #

hash :: Hits -> Int #

FromJSON Hits Source # 
Instance details

Defined in Amazonka.CloudSearchDomains.Types.Hits

type Rep Hits Source # 
Instance details

Defined in Amazonka.CloudSearchDomains.Types.Hits

type Rep Hits = D1 ('MetaData "Hits" "Amazonka.CloudSearchDomains.Types.Hits" "libZSservicesZSamazonka-cloudsearch-domainsZSamazonka-cloudsearch-domains" 'False) (C1 ('MetaCons "Hits'" 'PrefixI 'True) ((S1 ('MetaSel ('Just "cursor") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :*: S1 ('MetaSel ('Just "hit") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe [Hit]))) :*: (S1 ('MetaSel ('Just "start") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Integer)) :*: S1 ('MetaSel ('Just "found") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Integer)))))

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:hit:Hits', hits_hit - A document that matches the search request.

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

$sel:found:Hits', hits_found - The total number of documents that match the search request.

hits_cursor :: Lens' Hits (Maybe Text) Source #

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

hits_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.

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

The total number of documents that match the search request.

SearchStatus

data SearchStatus Source #

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

See: newSearchStatus smart constructor.

Constructors

SearchStatus' 

Fields

Instances

Instances details
Eq SearchStatus Source # 
Instance details

Defined in Amazonka.CloudSearchDomains.Types.SearchStatus

Read SearchStatus Source # 
Instance details

Defined in Amazonka.CloudSearchDomains.Types.SearchStatus

Show SearchStatus Source # 
Instance details

Defined in Amazonka.CloudSearchDomains.Types.SearchStatus

Generic SearchStatus Source # 
Instance details

Defined in Amazonka.CloudSearchDomains.Types.SearchStatus

Associated Types

type Rep SearchStatus :: Type -> Type #

NFData SearchStatus Source # 
Instance details

Defined in Amazonka.CloudSearchDomains.Types.SearchStatus

Methods

rnf :: SearchStatus -> () #

Hashable SearchStatus Source # 
Instance details

Defined in Amazonka.CloudSearchDomains.Types.SearchStatus

FromJSON SearchStatus Source # 
Instance details

Defined in Amazonka.CloudSearchDomains.Types.SearchStatus

type Rep SearchStatus Source # 
Instance details

Defined in Amazonka.CloudSearchDomains.Types.SearchStatus

type Rep SearchStatus = D1 ('MetaData "SearchStatus" "Amazonka.CloudSearchDomains.Types.SearchStatus" "libZSservicesZSamazonka-cloudsearch-domainsZSamazonka-cloudsearch-domains" '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

Instances

Instances details
Eq SuggestModel Source # 
Instance details

Defined in Amazonka.CloudSearchDomains.Types.SuggestModel

Read SuggestModel Source # 
Instance details

Defined in Amazonka.CloudSearchDomains.Types.SuggestModel

Show SuggestModel Source # 
Instance details

Defined in Amazonka.CloudSearchDomains.Types.SuggestModel

Generic SuggestModel Source # 
Instance details

Defined in Amazonka.CloudSearchDomains.Types.SuggestModel

Associated Types

type Rep SuggestModel :: Type -> Type #

NFData SuggestModel Source # 
Instance details

Defined in Amazonka.CloudSearchDomains.Types.SuggestModel

Methods

rnf :: SuggestModel -> () #

Hashable SuggestModel Source # 
Instance details

Defined in Amazonka.CloudSearchDomains.Types.SuggestModel

FromJSON SuggestModel Source # 
Instance details

Defined in Amazonka.CloudSearchDomains.Types.SuggestModel

type Rep SuggestModel Source # 
Instance details

Defined in Amazonka.CloudSearchDomains.Types.SuggestModel

type Rep SuggestModel = D1 ('MetaData "SuggestModel" "Amazonka.CloudSearchDomains.Types.SuggestModel" "libZSservicesZSamazonka-cloudsearch-domainsZSamazonka-cloudsearch-domains" 'False) (C1 ('MetaCons "SuggestModel'" 'PrefixI 'True) (S1 ('MetaSel ('Just "found") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Integer)) :*: (S1 ('MetaSel ('Just "suggestions") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe [SuggestionMatch])) :*: S1 ('MetaSel ('Just "query") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)))))

newSuggestModel :: SuggestModel Source #

Create a value of SuggestModel with all optional fields omitted.

Use generic-lens or optics to modify other optional fields.

The following record fields are available, with the corresponding lenses provided for backwards compatibility:

$sel:found:SuggestModel', suggestModel_found - The number of documents that were found to match the query string.

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

$sel:query:SuggestModel', suggestModel_query - The query string specified in the suggest request.

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

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

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

The documents that match the query string.

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

The query string specified in the suggest request.

SuggestStatus

data SuggestStatus Source #

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

See: newSuggestStatus smart constructor.

Constructors

SuggestStatus' 

Fields

Instances

Instances details
Eq SuggestStatus Source # 
Instance details

Defined in Amazonka.CloudSearchDomains.Types.SuggestStatus

Read SuggestStatus Source # 
Instance details

Defined in Amazonka.CloudSearchDomains.Types.SuggestStatus

Show SuggestStatus Source # 
Instance details

Defined in Amazonka.CloudSearchDomains.Types.SuggestStatus

Generic SuggestStatus Source # 
Instance details

Defined in Amazonka.CloudSearchDomains.Types.SuggestStatus

Associated Types

type Rep SuggestStatus :: Type -> Type #

NFData SuggestStatus Source # 
Instance details

Defined in Amazonka.CloudSearchDomains.Types.SuggestStatus

Methods

rnf :: SuggestStatus -> () #

Hashable SuggestStatus Source # 
Instance details

Defined in Amazonka.CloudSearchDomains.Types.SuggestStatus

FromJSON SuggestStatus Source # 
Instance details

Defined in Amazonka.CloudSearchDomains.Types.SuggestStatus

type Rep SuggestStatus Source # 
Instance details

Defined in Amazonka.CloudSearchDomains.Types.SuggestStatus

type Rep SuggestStatus = D1 ('MetaData "SuggestStatus" "Amazonka.CloudSearchDomains.Types.SuggestStatus" "libZSservicesZSamazonka-cloudsearch-domainsZSamazonka-cloudsearch-domains" '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

Instances

Instances details
Eq SuggestionMatch Source # 
Instance details

Defined in Amazonka.CloudSearchDomains.Types.SuggestionMatch

Read SuggestionMatch Source # 
Instance details

Defined in Amazonka.CloudSearchDomains.Types.SuggestionMatch

Show SuggestionMatch Source # 
Instance details

Defined in Amazonka.CloudSearchDomains.Types.SuggestionMatch

Generic SuggestionMatch Source # 
Instance details

Defined in Amazonka.CloudSearchDomains.Types.SuggestionMatch

Associated Types

type Rep SuggestionMatch :: Type -> Type #

NFData SuggestionMatch Source # 
Instance details

Defined in Amazonka.CloudSearchDomains.Types.SuggestionMatch

Methods

rnf :: SuggestionMatch -> () #

Hashable SuggestionMatch Source # 
Instance details

Defined in Amazonka.CloudSearchDomains.Types.SuggestionMatch

FromJSON SuggestionMatch Source # 
Instance details

Defined in Amazonka.CloudSearchDomains.Types.SuggestionMatch

type Rep SuggestionMatch Source # 
Instance details

Defined in Amazonka.CloudSearchDomains.Types.SuggestionMatch

type Rep SuggestionMatch = D1 ('MetaData "SuggestionMatch" "Amazonka.CloudSearchDomains.Types.SuggestionMatch" "libZSservicesZSamazonka-cloudsearch-domainsZSamazonka-cloudsearch-domains" 'False) (C1 ('MetaCons "SuggestionMatch'" 'PrefixI 'True) (S1 ('MetaSel ('Just "suggestion") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :*: (S1 ('MetaSel ('Just "score") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Integer)) :*: S1 ('MetaSel ('Just "id") '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:suggestion:SuggestionMatch', suggestionMatch_suggestion - The string that matches the query string specified in the SuggestRequest.

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

$sel:id:SuggestionMatch', suggestionMatch_id - The document ID of the suggested document.

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

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

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

The relevance score of a suggested match.

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

The document ID of the suggested document.