@datafire/amazonaws_cloudsearchdomain

Client library for Amazon CloudSearch Domain

Installation and Usage

npm install --save @datafire/amazonaws_cloudsearchdomain

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

UploadDocuments

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

Input

• input object
  • documents required Blob

Output

• output UploadDocumentsResponse

Search

amazonaws_cloudsearchdomain.Search({}, context)

Input

• input object

Output

• output SearchResponse

Suggest

amazonaws_cloudsearchdomain.Suggest({}, context)

Input

• input object

Output

• output SuggestResponse

Definitions

Adds

• Adds integer

Blob

• Blob string

Bucket

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

BucketInfo

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

BucketList

• BucketList array
  • items Bucket

ContentType

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

Cursor

• Cursor string

Deletes

• Deletes integer

DocumentServiceException

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

DocumentServiceWarning

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

DocumentServiceWarnings

• DocumentServiceWarnings array
  • items DocumentServiceWarning

Double

• Double number

Expr

• Expr string

Exprs

• Exprs array
  • items object
    • key String
    • value String

Facet

• Facet string

Facets

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

FieldStats

• 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

FieldValue

• FieldValue array
  • items String

Fields

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

FilterQuery

• FilterQuery string

Highlight

• Highlight string

Highlights

• Highlights array
  • items object
    • key String
    • value String

Hit

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

HitList

• HitList array
  • items Hit

Hits

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

Long

• Long integer

Partial

• Partial boolean

Query

• Query string

QueryOptions

• QueryOptions string

QueryParser

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

Return

• Return string

SearchException

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

SearchRequest

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

SearchResponse

• 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

SearchStatus

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

Size

• Size integer

Sort

• Sort string

Start

• Start integer

Stat

• Stat string

Stats

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

String

• String string

SuggestModel

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

SuggestRequest

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

SuggestResponse

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

SuggestStatus

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

Suggester

• Suggester string

SuggestionMatch

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

Suggestions

• Suggestions array
  • items SuggestionMatch

SuggestionsSize

• SuggestionsSize integer

UploadDocumentsRequest

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

UploadDocumentsResponse

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