npm package discovery and stats viewer.

Discover Tips

  • General search

    [free text search, go nuts!]

  • Package details

    pkg:[package-name]

  • User packages

    @[username]

Sponsor

Optimize Toolset

I’ve always been into building performant and accessible sites, but lately I’ve been taking it extremely seriously. So much so that I’ve been building a tool to help me optimize and monitor the sites that I build to make sure that I’m making an attempt to offer the best experience to those who visit them. If you’re into performant, accessible and SEO friendly sites, you might like it too! You can check it out at Optimize Toolset.

About

Hi, 👋, I’m Ryan Hefner  and I built this site for me, and you! The goal of this site was to provide an easy way for me to check the stats on my npm packages, both for prioritizing issues and updates, and to give me a little kick in the pants to keep up on stuff.

As I was building it, I realized that I was actually using the tool to build the tool, and figured I might as well put this out there and hopefully others will find it to be a fast and useful way to search and browse npm packages as I have.

If you’re interested in other things I’m working on, follow me on Twitter or check out the open source projects I’ve been publishing on GitHub.

I am also working on a Twitter bot for this site to tweet the most popular, newest, random packages from npm. Please follow that account now and it will start sending out packages soon–ish.

Open Software & Tools

This site wouldn’t be possible without the immense generosity and tireless efforts from the people who make contributions to the world and share their work via open source initiatives. Thank you 🙏

© 2024 – Pkg Stats / Ryan Hefner

@datafire/amazonaws_cloudsearch

v5.0.0

Published

DataFire integration for Amazon CloudSearch

Downloads

3

Vulnerabilities

Powered byPowered by Snyk
  • 0High
  • 0Medium
  • 0Low

Links

Git

Maintainers

datafiredatafire

Keywords

Readme

@datafire/amazonaws_cloudsearch

Client library for Amazon CloudSearch

Installation and Usage

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

amazonaws_cloudsearch.BuildSuggesters({
  "DomainName": ""
}).then(data => {
  console.log(data);
});

Description

Amazon CloudSearch Configuration Service You use the Amazon CloudSearch configuration service to create, configure, and manage search domains. Configuration service requests are submitted using the AWS Query protocol. AWS Query requests are HTTP or HTTPS requests submitted via HTTP GET or POST with a query parameter named Action. The endpoint for configuration service requests is region-specific: cloudsearch.region.amazonaws.com. For example, cloudsearch.us-east-1.amazonaws.com. For a current list of supported regions and endpoints, see Regions and Endpoints.

Actions

BuildSuggesters

amazonaws_cloudsearch.BuildSuggesters({
  "DomainName": ""
}, context)

Input

Output

CreateDomain

amazonaws_cloudsearch.CreateDomain({
  "DomainName": ""
}, context)

Input

Output

DefineAnalysisScheme

amazonaws_cloudsearch.DefineAnalysisScheme({
  "DomainName": "",
  "AnalysisScheme": {
    "AnalysisSchemeName": "",
    "AnalysisSchemeLanguage": ""
  }
}, context)

Input

Output

DefineExpression

amazonaws_cloudsearch.DefineExpression({
  "DomainName": "",
  "Expression": {
    "ExpressionName": "",
    "ExpressionValue": ""
  }
}, context)

Input

Output

DefineIndexField

amazonaws_cloudsearch.DefineIndexField({
  "DomainName": "",
  "IndexField": {
    "IndexFieldName": "",
    "IndexFieldType": ""
  }
}, context)

Input

Output

DefineSuggester

amazonaws_cloudsearch.DefineSuggester({
  "DomainName": "",
  "Suggester": {
    "SuggesterName": "",
    "DocumentSuggesterOptions": {
      "SourceField": ""
    }
  }
}, context)

Input

Output

DeleteAnalysisScheme

amazonaws_cloudsearch.DeleteAnalysisScheme({
  "DomainName": "",
  "AnalysisSchemeName": ""
}, context)

Input

Output

DeleteDomain

amazonaws_cloudsearch.DeleteDomain({
  "DomainName": ""
}, context)

Input

Output

DeleteExpression

amazonaws_cloudsearch.DeleteExpression({
  "DomainName": "",
  "ExpressionName": ""
}, context)

Input

Output

DeleteIndexField

amazonaws_cloudsearch.DeleteIndexField({
  "DomainName": "",
  "IndexFieldName": ""
}, context)

Input

Output

DeleteSuggester

amazonaws_cloudsearch.DeleteSuggester({
  "DomainName": "",
  "SuggesterName": ""
}, context)

Input

Output

DescribeAnalysisSchemes

amazonaws_cloudsearch.DescribeAnalysisSchemes({
  "DomainName": ""
}, context)

Input

Output

DescribeAvailabilityOptions

amazonaws_cloudsearch.DescribeAvailabilityOptions({
  "DomainName": ""
}, context)

Input

Output

DescribeDomains

amazonaws_cloudsearch.DescribeDomains({}, context)

Input

Output

DescribeExpressions

amazonaws_cloudsearch.DescribeExpressions({
  "DomainName": ""
}, context)

Input

Output

DescribeIndexFields

amazonaws_cloudsearch.DescribeIndexFields({
  "DomainName": ""
}, context)

Input

Output

DescribeScalingParameters

amazonaws_cloudsearch.DescribeScalingParameters({
  "DomainName": ""
}, context)

Input

Output

DescribeServiceAccessPolicies

amazonaws_cloudsearch.DescribeServiceAccessPolicies({
  "DomainName": ""
}, context)

Input

Output

DescribeSuggesters

amazonaws_cloudsearch.DescribeSuggesters({
  "DomainName": ""
}, context)

Input

Output

IndexDocuments

amazonaws_cloudsearch.IndexDocuments({
  "DomainName": ""
}, context)

Input

Output

ListDomainNames

amazonaws_cloudsearch.ListDomainNames({}, context)

Input

  • input object

Output

UpdateAvailabilityOptions

amazonaws_cloudsearch.UpdateAvailabilityOptions({
  "DomainName": "",
  "MultiAZ": true
}, context)

Input

Output

UpdateScalingParameters

amazonaws_cloudsearch.UpdateScalingParameters({
  "DomainName": "",
  "ScalingParameters": {}
}, context)

Input

Output

UpdateServiceAccessPolicies

amazonaws_cloudsearch.UpdateServiceAccessPolicies({
  "DomainName": "",
  "AccessPolicies": ""
}, context)

Input

Output

Definitions

APIVersion

  • APIVersion string: The Amazon CloudSearch API version for a domain: 2011-02-01 or 2013-01-01.

ARN

  • ARN string: The Amazon Resource Name (ARN) of the search domain. See Identifiers for IAM Entities in Using AWS Identity and Access Management for more information.

AccessPoliciesStatus

  • AccessPoliciesStatus object: The configured access rules for the domain's document and search endpoints, and the current status of those rules.

AlgorithmicStemming

  • AlgorithmicStemming string (values: none, minimal, light, full)

AnalysisOptions

  • AnalysisOptions object: Synonyms, stopwords, and stemming options for an analysis scheme. Includes tokenization dictionary for Japanese.

AnalysisScheme

  • AnalysisScheme object: Configuration information for an analysis scheme. Each analysis scheme has a unique name and specifies the language of the text to be processed. The following options can be configured for an analysis scheme: Synonyms, Stopwords, StemmingDictionary, JapaneseTokenizationDictionary and AlgorithmicStemming.

AnalysisSchemeLanguage

  • AnalysisSchemeLanguage string (values: ar, bg, ca, cs, da, de, el, en, es, eu, fa, fi, fr, ga, gl, he, hi, hu, hy, id, it, ja, ko, lv, mul, nl, no, pt, ro, ru, sv, th, tr, zh-Hans, zh-Hant): An IETF RFC 4646 language code or mul for multiple languages.

AnalysisSchemeStatus

  • AnalysisSchemeStatus object: The status and configuration of an AnalysisScheme.

AnalysisSchemeStatusList

  • AnalysisSchemeStatusList array: A list of the analysis schemes configured for a domain.

AvailabilityOptionsStatus

  • AvailabilityOptionsStatus object: The status and configuration of the domain's availability options.

BaseException

Boolean

  • Boolean boolean

BuildSuggestersRequest

  • BuildSuggestersRequest object: Container for the parameters to the BuildSuggester operation. Specifies the name of the domain you want to update.

BuildSuggestersResponse

  • BuildSuggestersResponse object: The result of a BuildSuggester request. Contains a list of the fields used for suggestions.

CreateDomainRequest

  • CreateDomainRequest object: Container for the parameters to the CreateDomain operation. Specifies a name for the new search domain.

CreateDomainResponse

  • CreateDomainResponse object: The result of a CreateDomainRequest. Contains the status of a newly created domain.

DateArrayOptions

  • DateArrayOptions object: Options for a field that contains an array of dates. Present if IndexFieldType specifies the field is of type date-array. All options are enabled by default.

DateOptions

  • DateOptions object: Options for a date field. Dates and times are specified in UTC (Coordinated Universal Time) according to IETF RFC3339: yyyy-mm-ddT00:00:00Z. Present if IndexFieldType specifies the field is of type date. All options are enabled by default.

DefineAnalysisSchemeRequest

  • DefineAnalysisSchemeRequest object: Container for the parameters to the DefineAnalysisScheme operation. Specifies the name of the domain you want to update and the analysis scheme configuration.

DefineAnalysisSchemeResponse

  • DefineAnalysisSchemeResponse object: The result of a DefineAnalysisScheme request. Contains the status of the newly-configured analysis scheme.

DefineExpressionRequest

  • DefineExpressionRequest object: Container for the parameters to the DefineExpression operation. Specifies the name of the domain you want to update and the expression you want to configure.

DefineExpressionResponse

  • DefineExpressionResponse object: The result of a DefineExpression request. Contains the status of the newly-configured expression.

DefineIndexFieldRequest

  • DefineIndexFieldRequest object: Container for the parameters to the DefineIndexField operation. Specifies the name of the domain you want to update and the index field configuration.

DefineIndexFieldResponse

  • DefineIndexFieldResponse object: The result of a DefineIndexField request. Contains the status of the newly-configured index field.

DefineSuggesterRequest

  • DefineSuggesterRequest object: Container for the parameters to the DefineSuggester operation. Specifies the name of the domain you want to update and the suggester configuration.

DefineSuggesterResponse

  • DefineSuggesterResponse object: The result of a DefineSuggester request. Contains the status of the newly-configured suggester.

DeleteAnalysisSchemeRequest

  • DeleteAnalysisSchemeRequest object: Container for the parameters to the DeleteAnalysisScheme operation. Specifies the name of the domain you want to update and the analysis scheme you want to delete.

DeleteAnalysisSchemeResponse

  • DeleteAnalysisSchemeResponse object: The result of a DeleteAnalysisScheme request. Contains the status of the deleted analysis scheme.

DeleteDomainRequest

  • DeleteDomainRequest object: Container for the parameters to the DeleteDomain operation. Specifies the name of the domain you want to delete.

DeleteDomainResponse

  • DeleteDomainResponse object: The result of a DeleteDomain request. Contains the status of a newly deleted domain, or no status if the domain has already been completely deleted.

DeleteExpressionRequest

  • DeleteExpressionRequest object: Container for the parameters to the DeleteExpression operation. Specifies the name of the domain you want to update and the name of the expression you want to delete.

DeleteExpressionResponse

  • DeleteExpressionResponse object: The result of a DeleteExpression request. Specifies the expression being deleted.

DeleteIndexFieldRequest

  • DeleteIndexFieldRequest object: Container for the parameters to the DeleteIndexField operation. Specifies the name of the domain you want to update and the name of the index field you want to delete.

DeleteIndexFieldResponse

  • DeleteIndexFieldResponse object: The result of a DeleteIndexField request.

DeleteSuggesterRequest

  • DeleteSuggesterRequest object: Container for the parameters to the DeleteSuggester operation. Specifies the name of the domain you want to update and name of the suggester you want to delete.

DeleteSuggesterResponse

  • DeleteSuggesterResponse object: The result of a DeleteSuggester request. Contains the status of the deleted suggester.

DescribeAnalysisSchemesRequest

  • DescribeAnalysisSchemesRequest object: Container for the parameters to the DescribeAnalysisSchemes operation. Specifies the name of the domain you want to describe. To limit the response to particular analysis schemes, specify the names of the analysis schemes you want to describe. To show the active configuration and exclude any pending changes, set the Deployed option to true.

DescribeAnalysisSchemesResponse

  • DescribeAnalysisSchemesResponse object: The result of a DescribeAnalysisSchemes request. Contains the analysis schemes configured for the domain specified in the request.

DescribeAvailabilityOptionsRequest

  • DescribeAvailabilityOptionsRequest object: Container for the parameters to the DescribeAvailabilityOptions operation. Specifies the name of the domain you want to describe. To show the active configuration and exclude any pending changes, set the Deployed option to true.

DescribeAvailabilityOptionsResponse

  • DescribeAvailabilityOptionsResponse object: The result of a DescribeAvailabilityOptions request. Indicates whether or not the Multi-AZ option is enabled for the domain specified in the request.

DescribeDomainsRequest

  • DescribeDomainsRequest object: Container for the parameters to the DescribeDomains operation. By default shows the status of all domains. To restrict the response to particular domains, specify the names of the domains you want to describe.

DescribeDomainsResponse

  • DescribeDomainsResponse object: The result of a DescribeDomains request. Contains the status of the domains specified in the request or all domains owned by the account.

DescribeExpressionsRequest

  • DescribeExpressionsRequest object: Container for the parameters to the DescribeDomains operation. Specifies the name of the domain you want to describe. To restrict the response to particular expressions, specify the names of the expressions you want to describe. To show the active configuration and exclude any pending changes, set the Deployed option to true.

DescribeExpressionsResponse

  • DescribeExpressionsResponse object: The result of a DescribeExpressions request. Contains the expressions configured for the domain specified in the request.

DescribeIndexFieldsRequest

  • DescribeIndexFieldsRequest object: Container for the parameters to the DescribeIndexFields operation. Specifies the name of the domain you want to describe. To restrict the response to particular index fields, specify the names of the index fields you want to describe. To show the active configuration and exclude any pending changes, set the Deployed option to true.

DescribeIndexFieldsResponse

  • DescribeIndexFieldsResponse object: The result of a DescribeIndexFields request. Contains the index fields configured for the domain specified in the request.

DescribeScalingParametersRequest

  • DescribeScalingParametersRequest object: Container for the parameters to the DescribeScalingParameters operation. Specifies the name of the domain you want to describe.

DescribeScalingParametersResponse

  • DescribeScalingParametersResponse object: The result of a DescribeScalingParameters request. Contains the scaling parameters configured for the domain specified in the request.

DescribeServiceAccessPoliciesRequest

  • DescribeServiceAccessPoliciesRequest object: Container for the parameters to the DescribeServiceAccessPolicies operation. Specifies the name of the domain you want to describe. To show the active configuration and exclude any pending changes, set the Deployed option to true.

DescribeServiceAccessPoliciesResponse

  • DescribeServiceAccessPoliciesResponse object: The result of a DescribeServiceAccessPolicies request.

DescribeSuggestersRequest

  • DescribeSuggestersRequest object: Container for the parameters to the DescribeSuggester operation. Specifies the name of the domain you want to describe. To restrict the response to particular suggesters, specify the names of the suggesters you want to describe. To show the active configuration and exclude any pending changes, set the Deployed option to true.

DescribeSuggestersResponse

  • DescribeSuggestersResponse object: The result of a DescribeSuggesters request.

DisabledOperationException

  • DisabledOperationException object: The request was rejected because it attempted an operation which is not enabled.

DocumentSuggesterOptions

DomainId

  • DomainId string: An internally generated unique identifier for a domain.

DomainName

  • DomainName string: A string that represents the name of a domain. Domain names are unique across the domains owned by an account within an AWS region. Domain names start with a letter or number and can contain the following characters: a-z (lowercase), 0-9, and - (hyphen).

DomainNameList

  • DomainNameList array: A list of domain names.

DomainNameMap

DomainStatus

DomainStatusList

  • DomainStatusList array: A list that contains the status of each requested domain.

Double

  • Double number

DoubleArrayOptions

  • DoubleArrayOptions object: Options for a field that contains an array of double-precision 64-bit floating point values. Present if IndexFieldType specifies the field is of type double-array. All options are enabled by default.

DoubleOptions

  • DoubleOptions object: Options for a double-precision 64-bit floating point field. Present if IndexFieldType specifies the field is of type double. All options are enabled by default.

DynamicFieldName

  • DynamicFieldName string

DynamicFieldNameList

ErrorCode

  • ErrorCode string: A machine-parsable string error or warning code.

ErrorMessage

  • ErrorMessage string: A human-readable string error or warning message.

Expression

  • Expression object: A named expression that can be evaluated at search time. Can be used to sort the search results, define other expressions, or return computed information in the search results.

ExpressionStatus

  • ExpressionStatus object: The value of an Expression and its current status.

ExpressionStatusList

  • ExpressionStatusList array: Contains the status of multiple expressions.

ExpressionValue

  • ExpressionValue string: The expression to evaluate for sorting while processing a search request. The Expression syntax is based on JavaScript expressions. For more information, see Configuring Expressions in the Amazon CloudSearch Developer Guide.

FieldName

  • FieldName string: A string that represents the name of an index field. CloudSearch supports regular index fields as well as dynamic fields. A dynamic field's name defines a pattern that begins or ends with a wildcard. Any document fields that don't map to a regular index field but do match a dynamic field's pattern are configured with the dynamic field's indexing options. Regular field names begin with a letter and can contain the following characters: a-z (lowercase), 0-9, and _ (underscore). Dynamic field names must begin or end with a wildcard (*). The wildcard can also be the only character in a dynamic field name. Multiple wildcards, and wildcards embedded within a string are not supported. The name score is reserved and cannot be used as a field name. To reference a document's ID, you can use the name _id.

FieldNameCommaList

  • FieldNameCommaList string

FieldNameList

  • FieldNameList array: A list of field names.

FieldValue

  • FieldValue string: The value of a field attribute.

IndexDocumentsRequest

  • IndexDocumentsRequest object: Container for the parameters to the IndexDocuments operation. Specifies the name of the domain you want to re-index.

IndexDocumentsResponse

  • IndexDocumentsResponse object: The result of an IndexDocuments request. Contains the status of the indexing operation, including the fields being indexed.

IndexField

IndexFieldStatus

  • IndexFieldStatus object: The value of an IndexField and its current status.

IndexFieldStatusList

  • IndexFieldStatusList array: Contains the status of multiple index fields.

IndexFieldType

  • IndexFieldType string (values: int, double, literal, text, date, latlon, int-array, double-array, literal-array, text-array, date-array): The type of field. The valid options for a field depend on the field type. For more information about the supported field types, see Configuring Index Fields in the Amazon CloudSearch Developer Guide.

InstanceCount

  • InstanceCount integer

IntArrayOptions

  • IntArrayOptions object: Options for a field that contains an array of 64-bit signed integers. Present if IndexFieldType specifies the field is of type int-array. All options are enabled by default.

IntOptions

  • IntOptions object: Options for a 64-bit signed integer field. Present if IndexFieldType specifies the field is of type int. All options are enabled by default.

InternalException

  • InternalException object: An internal error occurred while processing the request. If this problem persists, report an issue from the Service Health Dashboard.

InvalidTypeException

  • InvalidTypeException object: The request was rejected because it specified an invalid type definition.

LatLonOptions

  • LatLonOptions object: Options for a latlon field. A latlon field contains a location stored as a latitude and longitude value pair. Present if IndexFieldType specifies the field is of type latlon. All options are enabled by default.

LimitExceededException

  • LimitExceededException object: The request was rejected because a resource limit has already been met.

Limits

ListDomainNamesResponse

  • ListDomainNamesResponse object: The result of a ListDomainNames request. Contains a list of the domains owned by an account.

LiteralArrayOptions

  • LiteralArrayOptions object: Options for a field that contains an array of literal strings. Present if IndexFieldType specifies the field is of type literal-array. All options are enabled by default.

LiteralOptions

  • LiteralOptions object: Options for literal field. Present if IndexFieldType specifies the field is of type literal. All options are enabled by default.

Long

  • Long integer

MaximumPartitionCount

  • MaximumPartitionCount integer

MaximumReplicationCount

  • MaximumReplicationCount integer

MultiAZ

  • MultiAZ boolean

OptionState

  • OptionState string (values: RequiresIndexDocuments, Processing, Active, FailedToValidate): The state of processing a change to an option. One of: RequiresIndexDocuments: The option's latest value will not be deployed until IndexDocuments has been called and indexing is complete. Processing: The option's latest value is in the process of being activated. Active: The option's latest value is fully deployed. FailedToValidate: The option value is not compatible with the domain's data and cannot be used to index the data. You must either modify the option value or update or remove the incompatible documents.

OptionStatus

PartitionCount

  • PartitionCount integer: The number of partitions used to hold the domain's index.

PartitionInstanceType

  • PartitionInstanceType string (values: search.m1.small, search.m1.large, search.m2.xlarge, search.m2.2xlarge, search.m3.medium, search.m3.large, search.m3.xlarge, search.m3.2xlarge): The instance type (such as search.m1.small) on which an index partition is hosted.

PolicyDocument

  • PolicyDocument string: Access rules for a domain's document or search service endpoints. For more information, see Configuring Access for a Search Domain in the Amazon CloudSearch Developer Guide. The maximum size of a policy document is 100 KB.

ResourceNotFoundException

  • ResourceNotFoundException object: The request was rejected because it attempted to reference a resource that does not exist.

ScalingParameters

  • ScalingParameters object: The desired instance type and desired number of replicas of each index partition.

ScalingParametersStatus

  • ScalingParametersStatus object: The status and configuration of a search domain's scaling parameters.

SearchInstanceType

  • SearchInstanceType string: The instance type (such as search.m1.small) that is being used to process search requests.

ServiceEndpoint

  • ServiceEndpoint object: The endpoint to which service requests can be submitted.

ServiceUrl

  • ServiceUrl string: The endpoint to which service requests can be submitted. For example, search-imdb-movies-oopcnjfn6ugofer3zx5iadxxca.eu-west-1.cloudsearch.amazonaws.com or doc-imdb-movies-oopcnjfn6ugofer3zx5iadxxca.eu-west-1.cloudsearch.amazonaws.com.

StandardName

  • StandardName string: Names must begin with a letter and can contain the following characters: a-z (lowercase), 0-9, and _ (underscore).

StandardNameList

String

  • String string

Suggester

  • Suggester object: Configuration information for a search suggester. Each suggester has a unique name and specifies the text field you want to use for suggestions. The following options can be configured for a suggester: FuzzyMatching, SortExpression.

SuggesterFuzzyMatching

  • SuggesterFuzzyMatching string (values: none, low, high)

SuggesterStatus

  • SuggesterStatus object: The value of a Suggester and its current status.

SuggesterStatusList

  • SuggesterStatusList array: Contains the status of multiple suggesters.

TextArrayOptions

  • TextArrayOptions object: Options for a field that contains an array of text strings. Present if IndexFieldType specifies the field is of type text-array. A text-array field is always searchable. All options are enabled by default.

TextOptions

  • TextOptions object: Options for text field. Present if IndexFieldType specifies the field is of type text. A text field is always searchable. All options are enabled by default.

UIntValue

  • UIntValue integer

UpdateAvailabilityOptionsRequest

  • UpdateAvailabilityOptionsRequest object: Container for the parameters to the UpdateAvailabilityOptions operation. Specifies the name of the domain you want to update and the Multi-AZ availability option.

UpdateAvailabilityOptionsResponse

  • UpdateAvailabilityOptionsResponse object: The result of a UpdateAvailabilityOptions request. Contains the status of the domain's availability options.

UpdateScalingParametersRequest

  • UpdateScalingParametersRequest object: Container for the parameters to the UpdateScalingParameters operation. Specifies the name of the domain you want to update and the scaling parameters you want to configure.

UpdateScalingParametersResponse

  • UpdateScalingParametersResponse object: The result of a UpdateScalingParameters request. Contains the status of the newly-configured scaling parameters.

UpdateServiceAccessPoliciesRequest

  • UpdateServiceAccessPoliciesRequest object: Container for the parameters to the UpdateServiceAccessPolicies operation. Specifies the name of the domain you want to update and the access rules you want to configure.

UpdateServiceAccessPoliciesResponse

  • UpdateServiceAccessPoliciesResponse object: The result of an UpdateServiceAccessPolicies request. Contains the new access policies.

UpdateTimestamp

  • UpdateTimestamp string

Word

  • Word string