@datafire/amazonaws_cloudsearchdomain

Client library for Amazon CloudSearch Domain

Installation and Usage

``bash
npm install --save @datafire/amazonaws_cloudsearchdomain
`
`js
let amazonaws_cloudsearchdomain = require('@datafire/amazonaws_cloudsearchdomain').create({
accessKeyId: "",
secretAccessKey: "",
region: ""
});

amazonaws_cloudsearchdomain.UploadDocuments({
"documents": ""
}).then(data => {
console.log(data);
});
`

Description

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.

Actions

$3

`js
amazonaws_cloudsearchdomain.UploadDocuments({
"documents": ""
}, context)
`

#### Input
* input object
* documents required Blob

#### Output
* output UploadDocumentsResponse

$3

`js
amazonaws_cloudsearchdomain.Search({}, context)
`

#### Input
* input object

#### Output
* output SearchResponse

$3

`js
amazonaws_cloudsearchdomain.Suggest({}, context)
`

#### Input
* input object

#### Output
* output SuggestResponse

Definitions

$3


* Adds integer

$3

* Blob string

$3

* Bucket object: A container for facet information.
* count Long
* value String

$3

* BucketInfo object: A container for the calculated facet values and counts.
* buckets BucketList

$3

* BucketList array
* items Bucket

$3

* ContentType string (values: application/json, application/xml)

$3

* Cursor string

$3

* Deletes integer

$3

* DocumentServiceException object: Information about any problems encountered while processing an upload request.
* message String
* status String

$3

* DocumentServiceWarning object: A warning returned by the document service when an issue is discovered while processing an upload request.
* message String

$3

* DocumentServiceWarnings array
* items DocumentServiceWarning

$3

* Double number

$3

* Expr string

$3

* Exprs array
* items object
* key String
* value String

$3

* Facet string

$3

* Facets array
* items object
* key String
* value BucketInfo

$3

* FieldStats object: The statistics for a field calculated in the request.
* count Long
* max String
* mean String
* min String
* missing Long
* stddev Double
* sum Double
* sumOfSquares Double

$3

* FieldValue array
* items String

$3

* Fields array
* items object
* key String
* value FieldValue

$3

* FilterQuery string

$3

* Highlight string

$3

* Highlights array
* items object
* key String
* value String

$3

* Hit object: Information about a document that matches the search request.
* exprs Exprs
* fields Fields
* highlights Highlights
* id String

$3

* HitList array
* items Hit

$3

* Hits object: The collection of documents that match the search request.
* cursor String
* found Long
* hit HitList
* start Long

$3

* Long integer

$3

* Partial boolean

$3

* Query string

$3

* QueryOptions string

$3

* QueryParser string (values: simple, structured, lucene, dismax)

$3

* Return string

$3

* SearchException object: Information about any problems encountered while processing a search request.
* message String

$3

* SearchRequest object: Container for the parameters to the Search request.

$3

* SearchResponse object: The result of a Search request. Contains the documents that match the specified search criteria and any requested fields, highlights, and facet information.
* facets Facets
* hits Hits
* stats Stats
* status SearchStatus

$3

* SearchStatus object: Contains the resource id (rid) and the time it took to process the request (timems).
* rid String
* timems Long

$3

* Size integer

$3

* Sort string

$3

* Start integer

$3

* Stat string

$3

* Stats array: The statistics calculated in the request.
* items object
* key String
* value FieldStats

$3

* String string

$3

* SuggestModel object: Container for the suggestion information returned in a SuggestResponse.
* found Long
* query String
* suggestions Suggestions

$3

* SuggestRequest object: Container for the parameters to the Suggest request.

$3

* SuggestResponse object: Contains the response to a Suggest request.
* status SuggestStatus
* suggest SuggestModel

$3

* SuggestStatus object: Contains the resource id (rid) and the time it took to process the request (timems).
* rid String
* timems Long

$3

* Suggester string

$3

* SuggestionMatch object: An autocomplete suggestion that matches the query string specified in a SuggestRequest.
* id String
* score Long
* suggestion String

$3

* Suggestions array
* items SuggestionMatch

$3

* SuggestionsSize integer

$3

* UploadDocumentsRequest object: Container for the parameters to the UploadDocuments request.
* documents required Blob

$3

* UploadDocumentsResponse object`: Contains the response to an UploadDocuments request.
* adds Adds
* deletes Deletes
* status String
* warnings DocumentServiceWarnings