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.

See: AWS API Reference

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

Enum ContentType

Eq ContentType

Data ContentType

Ord ContentType

Read ContentType

Show ContentType

Generic ContentType

ToJSON ContentType

Hashable ContentType

ToHeader ContentType

ToQuery ContentType

ToByteString ContentType

FromText ContentType

ToText ContentType

Typeable * ContentType

type Rep ContentType

QueryParser

data QueryParser

Constructors

Dismax

Lucene

Simple

Structured

Instances

Enum QueryParser

Eq QueryParser

Data QueryParser

Ord QueryParser

Read QueryParser

Show QueryParser

Generic QueryParser

ToJSON QueryParser

Hashable QueryParser

ToHeader QueryParser

ToQuery QueryParser

ToByteString QueryParser

FromText QueryParser

ToText QueryParser

Typeable * QueryParser

type Rep QueryParser

Bucket

data Bucket

A container for facet information.

See: bucket smart constructor.

Instances

Eq Bucket

Data Bucket

Read Bucket

Show Bucket

Generic Bucket

FromJSON Bucket

Typeable * Bucket

type Rep Bucket

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

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

Data BucketInfo

Read BucketInfo

Show BucketInfo

Generic BucketInfo

FromJSON BucketInfo

Typeable * BucketInfo

type Rep BucketInfo

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

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

Data DocumentServiceWarning

Read DocumentServiceWarning

Show DocumentServiceWarning

Generic DocumentServiceWarning

FromJSON DocumentServiceWarning

Typeable * DocumentServiceWarning

type Rep DocumentServiceWarning

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

dswMessage :: Lens' DocumentServiceWarning (Maybe Text)

The description for a warning returned by the document service.

Hit

data Hit

Information about a document that matches the search request.

See: hit smart constructor.

Instances

Eq Hit

Data Hit

Read Hit

Show Hit

Generic Hit

FromJSON Hit

Typeable * Hit

type Rep Hit

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
• hitId
• hitHighlights
• hitFields

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

Data Hits

Read Hits

Show Hits

Generic Hits

FromJSON Hits

Typeable * Hits

type Rep Hits

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
• hHit
• hStart
• hFound

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

Data SearchStatus

Read SearchStatus

Show SearchStatus

Generic SearchStatus

FromJSON SearchStatus

Typeable * SearchStatus

type Rep SearchStatus

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

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

Data SuggestModel

Read SuggestModel

Show SuggestModel

Generic SuggestModel

FromJSON SuggestModel

Typeable * SuggestModel

type Rep SuggestModel

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
• smSuggestions
• smQuery

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

Data SuggestStatus

Read SuggestStatus

Show SuggestStatus

Generic SuggestStatus

FromJSON SuggestStatus

Typeable * SuggestStatus

type Rep SuggestStatus

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

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

Data SuggestionMatch

Read SuggestionMatch

Show SuggestionMatch

Generic SuggestionMatch

FromJSON SuggestionMatch

Typeable * SuggestionMatch

type Rep SuggestionMatch

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
• smScore
• smId

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.