Copyright | (c) 2013-2015 Brendan Hay |
---|---|
License | Mozilla Public License, v. 2.0. |
Maintainer | Brendan Hay <brendan.g.hay@gmail.com> |
Stability | auto-generated |
Portability | non-portable (GHC extensions) |
Safe Haskell | None |
Language | Haskell2010 |
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
- cloudSearchDomains :: Service
- _DocumentServiceException :: AsError a => Getting (First ServiceError) a ServiceError
- _SearchException :: AsError a => Getting (First ServiceError) a ServiceError
- module Network.AWS.CloudSearchDomains.Suggest
- module Network.AWS.CloudSearchDomains.UploadDocuments
- module Network.AWS.CloudSearchDomains.Search
- data ContentType
- data QueryParser
- = Dismax
- | Lucene
- | Simple
- | Structured
- data Bucket
- bucket :: Bucket
- bValue :: Lens' Bucket (Maybe Text)
- bCount :: Lens' Bucket (Maybe Integer)
- data BucketInfo
- bucketInfo :: BucketInfo
- biBuckets :: Lens' BucketInfo [Bucket]
- data DocumentServiceWarning
- documentServiceWarning :: DocumentServiceWarning
- dswMessage :: Lens' DocumentServiceWarning (Maybe Text)
- data Hit
- hit :: Hit
- hitExprs :: Lens' Hit (HashMap Text Text)
- hitId :: Lens' Hit (Maybe Text)
- hitHighlights :: Lens' Hit (HashMap Text Text)
- hitFields :: Lens' Hit (HashMap Text [Text])
- data Hits
- hits :: Hits
- hCursor :: Lens' Hits (Maybe Text)
- hHit :: Lens' Hits [Hit]
- hStart :: Lens' Hits (Maybe Integer)
- hFound :: Lens' Hits (Maybe Integer)
- data SearchStatus
- searchStatus :: SearchStatus
- sRid :: Lens' SearchStatus (Maybe Text)
- sTimems :: Lens' SearchStatus (Maybe Integer)
- data SuggestModel
- suggestModel :: SuggestModel
- smFound :: Lens' SuggestModel (Maybe Integer)
- smSuggestions :: Lens' SuggestModel [SuggestionMatch]
- smQuery :: Lens' SuggestModel (Maybe Text)
- data SuggestStatus
- suggestStatus :: SuggestStatus
- ssRid :: Lens' SuggestStatus (Maybe Text)
- ssTimems :: Lens' SuggestStatus (Maybe Integer)
- data SuggestionMatch
- suggestionMatch :: SuggestionMatch
- smSuggestion :: Lens' SuggestionMatch (Maybe Text)
- smScore :: Lens' SuggestionMatch (Maybe Integer)
- smId :: Lens' SuggestionMatch (Maybe Text)
Service Configuration
cloudSearchDomains :: Service Source
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 Source
Information about any problems encountered while processing an upload request.
SearchException
_SearchException :: AsError a => Getting (First ServiceError) a ServiceError Source
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
UploadDocuments
Search
Types
ContentType
data ContentType Source
QueryParser
data QueryParser Source
Bucket
A container for facet information.
See: bucket
smart constructor.
bCount :: 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: bucketInfo
smart constructor.
bucketInfo :: BucketInfo Source
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 :: Lens' BucketInfo [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: documentServiceWarning
smart constructor.
documentServiceWarning :: DocumentServiceWarning Source
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 :: Lens' DocumentServiceWarning (Maybe Text) Source
The description for a warning returned by the document service.
Hit
Information about a document that matches the search request.
See: hit
smart constructor.
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 :: Lens' Hit (HashMap Text Text) Source
The expressions returned from a document that matches the search request.
hitId :: Lens' Hit (Maybe Text) Source
The document ID of a document that matches the search request.
hitHighlights :: Lens' Hit (HashMap Text Text) Source
The highlights returned from a document that matches the search request.
hitFields :: Lens' Hit (HashMap Text [Text]) Source
The fields returned from a document that matches the search request.
Hits
The collection of documents that match the search request.
See: hits
smart constructor.
hCursor :: 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.
hFound :: 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: searchStatus
smart constructor.
searchStatus :: SearchStatus Source
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:
sTimems :: 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: suggestModel
smart constructor.
suggestModel :: SuggestModel Source
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 :: Lens' SuggestModel (Maybe Integer) Source
The number of documents that were found to match the query string.
smSuggestions :: Lens' SuggestModel [SuggestionMatch] Source
The documents that match the query string.
SuggestStatus
data SuggestStatus Source
Contains the resource id (rid
) and the time it took to process the
request (timems
).
See: suggestStatus
smart constructor.
suggestStatus :: SuggestStatus Source
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:
ssTimems :: 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: suggestionMatch
smart constructor.
suggestionMatch :: SuggestionMatch Source
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 :: Lens' SuggestionMatch (Maybe Text) Source
The string that matches the query string specified in the
SuggestRequest
.