@datafire/amazonaws_cloudsearch

Client library for Amazon CloudSearch

Installation and Usage

``bash
npm install --save @datafire/amazonaws_cloudsearch
`
`js
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

$3

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

#### Input
* input object
* DomainName required DomainName

#### Output
* output BuildSuggestersResponse

$3

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

#### Input
* input object
* DomainName required DomainName

#### Output
* output CreateDomainResponse

$3

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

#### Input
* input object
* AnalysisScheme required AnalysisScheme
* DomainName required DomainName

#### Output
* output DefineAnalysisSchemeResponse

$3

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

#### Input
* input object
* DomainName required DomainName
* Expression required Expression

#### Output
* output DefineExpressionResponse

$3

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

#### Input
* input object
* DomainName required DomainName
* IndexField required IndexField

#### Output
* output DefineIndexFieldResponse

$3

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

#### Input
* input object
* DomainName required DomainName
* Suggester required Suggester

#### Output
* output DefineSuggesterResponse

$3

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

#### Input
* input object
* AnalysisSchemeName required StandardName
* DomainName required DomainName

#### Output
* output DeleteAnalysisSchemeResponse

$3

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

#### Input
* input object
* DomainName required DomainName

#### Output
* output DeleteDomainResponse

$3

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

#### Input
* input object
* DomainName required DomainName
* ExpressionName required StandardName

#### Output
* output DeleteExpressionResponse

$3

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

#### Input
* input object
* DomainName required DomainName
* IndexFieldName required DynamicFieldName

#### Output
* output DeleteIndexFieldResponse

$3

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

#### Input
* input object
* DomainName required DomainName
* SuggesterName required StandardName

#### Output
* output DeleteSuggesterResponse

$3

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

#### Input
* input object
* AnalysisSchemeNames StandardNameList
* Deployed Boolean
* DomainName required DomainName

#### Output
* output DescribeAnalysisSchemesResponse

$3

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

#### Input
* input object
* Deployed Boolean
* DomainName required DomainName

#### Output
* output DescribeAvailabilityOptionsResponse

$3

`js
amazonaws_cloudsearch.DescribeDomains({}, context)
`

#### Input
* input object
* DomainNames DomainNameList

#### Output
* output DescribeDomainsResponse

$3

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

#### Input
* input object
* Deployed Boolean
* DomainName required DomainName
* ExpressionNames StandardNameList

#### Output
* output DescribeExpressionsResponse

$3

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

#### Input
* input object
* Deployed Boolean
* DomainName required DomainName
* FieldNames DynamicFieldNameList

#### Output
* output DescribeIndexFieldsResponse

$3

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

#### Input
* input object
* DomainName required DomainName

#### Output
* output DescribeScalingParametersResponse

$3

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

#### Input
* input object
* Deployed Boolean
* DomainName required DomainName

#### Output
* output DescribeServiceAccessPoliciesResponse

$3

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

#### Input
* input object
* Deployed Boolean
* DomainName required DomainName
* SuggesterNames StandardNameList

#### Output
* output DescribeSuggestersResponse

$3

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

#### Input
* input object
* DomainName required DomainName

#### Output
* output IndexDocumentsResponse

$3

`js
amazonaws_cloudsearch.ListDomainNames({}, context)
`

#### Input
* input object

#### Output
* output ListDomainNamesResponse

$3

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

#### Input
* input object
* DomainName required DomainName
* MultiAZ required Boolean

#### Output
* output UpdateAvailabilityOptionsResponse

$3

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

#### Input
* input object
* DomainName required DomainName
* ScalingParameters required ScalingParameters

#### Output
* output UpdateScalingParametersResponse

$3

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

#### Input
* input object
* AccessPolicies required PolicyDocument
* DomainName required DomainName

#### Output
* output UpdateServiceAccessPoliciesResponse

Definitions

$3


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

$3

* 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.

$3

* AccessPoliciesStatus object: The configured access rules for the domain's document and search endpoints, and the current status of those rules.
* Options required PolicyDocument
* Status required OptionStatus

$3

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

$3

* AnalysisOptions object: Synonyms, stopwords, and stemming options for an analysis scheme. Includes tokenization dictionary for Japanese.
* AlgorithmicStemming AlgorithmicStemming
* JapaneseTokenizationDictionary String
* StemmingDictionary String
* Stopwords String
* Synonyms String

$3

* 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.
* AnalysisOptions AnalysisOptions
* AnalysisSchemeLanguage required AnalysisSchemeLanguage
* AnalysisSchemeName required StandardName

$3

* 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.

$3

* AnalysisSchemeStatus object: The status and configuration of an AnalysisScheme.
* Options required AnalysisScheme
* Status required OptionStatus

$3

* AnalysisSchemeStatusList array: A list of the analysis schemes configured for a domain.
* items AnalysisSchemeStatus

$3

* AvailabilityOptionsStatus object: The status and configuration of the domain's availability options.
* Options required MultiAZ
* Status required OptionStatus

$3

* BaseException object: An error occurred while processing the request.
* Code ErrorCode
* Message ErrorMessage

$3

* Boolean boolean

$3

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

$3

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

$3

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

$3

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

$3

* 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.
* DefaultValue FieldValue
* FacetEnabled Boolean
* ReturnEnabled Boolean
* SearchEnabled Boolean
* SourceFields FieldNameCommaList

$3

* 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.
* DefaultValue FieldValue
* FacetEnabled Boolean
* ReturnEnabled Boolean
* SearchEnabled Boolean
* SortEnabled Boolean
* SourceField FieldName

$3

* 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.
* AnalysisScheme required AnalysisScheme
* DomainName required DomainName

$3

* DefineAnalysisSchemeResponse object: The result of a DefineAnalysisScheme request. Contains the status of the newly-configured analysis scheme.
* AnalysisScheme required AnalysisSchemeStatus

$3

* 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.
* DomainName required DomainName
* Expression required Expression

$3

* DefineExpressionResponse object: The result of a DefineExpression request. Contains the status of the newly-configured expression.
* Expression required ExpressionStatus

$3

* 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.
* DomainName required DomainName
* IndexField required IndexField

$3

* DefineIndexFieldResponse object: The result of a DefineIndexField request. Contains the status of the newly-configured index field.
* IndexField required IndexFieldStatus

$3

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

$3

* DefineSuggesterResponse object: The result of a DefineSuggester request. Contains the status of the newly-configured suggester.
* Suggester required SuggesterStatus

$3

* 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.
* AnalysisSchemeName required StandardName
* DomainName required DomainName

$3

* DeleteAnalysisSchemeResponse object: The result of a DeleteAnalysisScheme request. Contains the status of the deleted analysis scheme.
* AnalysisScheme required AnalysisSchemeStatus

$3

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

$3

* 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.
* DomainStatus DomainStatus

$3

* 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.
* DomainName required DomainName
* ExpressionName required StandardName

$3

* DeleteExpressionResponse object: The result of a DeleteExpression request. Specifies the expression being deleted.
* Expression required ExpressionStatus

$3

* 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.
* DomainName required DomainName
* IndexFieldName required DynamicFieldName

$3

* DeleteIndexFieldResponse object: The result of a DeleteIndexField request.
* IndexField required IndexFieldStatus

$3

* 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.
* DomainName required DomainName
* SuggesterName required StandardName

$3

* DeleteSuggesterResponse object: The result of a DeleteSuggester request. Contains the status of the deleted suggester.
* Suggester required SuggesterStatus

$3

* 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.
* AnalysisSchemeNames StandardNameList
* Deployed Boolean
* DomainName required DomainName

$3

* DescribeAnalysisSchemesResponse object: The result of a DescribeAnalysisSchemes request. Contains the analysis schemes configured for the domain specified in the request.
* AnalysisSchemes required AnalysisSchemeStatusList

$3

* 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.
* Deployed Boolean
* DomainName required DomainName

$3

* 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.
* AvailabilityOptions AvailabilityOptionsStatus

$3

* 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.
* DomainNames DomainNameList

$3

* 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.
* DomainStatusList required DomainStatusList

$3

* 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.
* Deployed Boolean
* DomainName required DomainName
* ExpressionNames StandardNameList

$3

* DescribeExpressionsResponse object: The result of a DescribeExpressions request. Contains the expressions configured for the domain specified in the request.
* Expressions required ExpressionStatusList

$3

* 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.
* Deployed Boolean
* DomainName required DomainName
* FieldNames DynamicFieldNameList

$3

* DescribeIndexFieldsResponse object: The result of a DescribeIndexFields request. Contains the index fields configured for the domain specified in the request.
* IndexFields required IndexFieldStatusList

$3

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

$3

* DescribeScalingParametersResponse object: The result of a DescribeScalingParameters request. Contains the scaling parameters configured for the domain specified in the request.
* ScalingParameters required ScalingParametersStatus

$3

* 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.
* Deployed Boolean
* DomainName required DomainName

$3

* DescribeServiceAccessPoliciesResponse object: The result of a DescribeServiceAccessPolicies request.
* AccessPolicies required AccessPoliciesStatus

$3

* 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.
* Deployed Boolean
* DomainName required DomainName
* SuggesterNames StandardNameList

$3

* DescribeSuggestersResponse object: The result of a DescribeSuggesters request.
* Suggesters required SuggesterStatusList

$3

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

$3

* DocumentSuggesterOptions object: Options for a search suggester.
* FuzzyMatching SuggesterFuzzyMatching
* SortExpression String
* SourceField required FieldName

$3

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

$3

* 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).

$3

* DomainNameList array: A list of domain names.
* items DomainName

$3

* DomainNameMap array: A collection of domain names.
* items object
* key DomainName
* value APIVersion

$3

* DomainStatus object: The current status of the search domain.
* ARN ARN
* Created Boolean
* Deleted Boolean
* DocService ServiceEndpoint
* DomainId required DomainId
* DomainName required DomainName
* Limits Limits
* Processing Boolean
* RequiresIndexDocuments required Boolean
* SearchInstanceCount InstanceCount
* SearchInstanceType SearchInstanceType
* SearchPartitionCount PartitionCount
* SearchService ServiceEndpoint

$3

* DomainStatusList array: A list that contains the status of each requested domain.
* items DomainStatus

$3

* Double number

$3

* 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.
* DefaultValue Double
* FacetEnabled Boolean
* ReturnEnabled Boolean
* SearchEnabled Boolean
* SourceFields FieldNameCommaList

$3

* 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.
* DefaultValue Double
* FacetEnabled Boolean
* ReturnEnabled Boolean
* SearchEnabled Boolean
* SortEnabled Boolean
* SourceField FieldName

$3

* DynamicFieldName string

$3

* DynamicFieldNameList array
* items DynamicFieldName

$3

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

$3

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

$3

* 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.
* ExpressionName required StandardName
* ExpressionValue required ExpressionValue

$3

* ExpressionStatus object: The value of an Expression and its current status.
* Options required Expression
* Status required OptionStatus

$3

* ExpressionStatusList array: Contains the status of multiple expressions.
* items ExpressionStatus

$3

* 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.

$3

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.

$3

* FieldNameCommaList string

$3

* FieldNameList array: A list of field names.
* items FieldName

$3

* FieldValue string: The value of a field attribute.

$3

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

$3

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

$3

* IndexField object: Configuration information for a field in the index, including its name, type, and options. The supported options depend on the IndexFieldType.
* DateArrayOptions DateArrayOptions
* DateOptions DateOptions
* DoubleArrayOptions DoubleArrayOptions
* DoubleOptions DoubleOptions
* IndexFieldName required DynamicFieldName
* IndexFieldType required IndexFieldType
* IntArrayOptions IntArrayOptions
* IntOptions IntOptions
* LatLonOptions LatLonOptions
* LiteralArrayOptions LiteralArrayOptions
* LiteralOptions LiteralOptions
* TextArrayOptions TextArrayOptions
* TextOptions TextOptions

$3

* IndexFieldStatus object: The value of an IndexField and its current status.
* Options required IndexField
* Status required OptionStatus

$3

* IndexFieldStatusList array: Contains the status of multiple index fields.
* items IndexFieldStatus

$3

* 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.

$3

* InstanceCount integer

$3

* 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.
* DefaultValue Long
* FacetEnabled Boolean
* ReturnEnabled Boolean
* SearchEnabled Boolean
* SourceFields FieldNameCommaList

$3

* 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.
* DefaultValue Long
* FacetEnabled Boolean
* ReturnEnabled Boolean
* SearchEnabled Boolean
* SortEnabled Boolean
* SourceField FieldName

$3

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

$3

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

$3

* 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.
* DefaultValue FieldValue
* FacetEnabled Boolean
* ReturnEnabled Boolean
* SearchEnabled Boolean
* SortEnabled Boolean
* SourceField FieldName

$3

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

$3

* Limits object
* MaximumPartitionCount required MaximumPartitionCount
* MaximumReplicationCount required MaximumReplicationCount

$3

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

$3

* 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.
* DefaultValue FieldValue
* FacetEnabled Boolean
* ReturnEnabled Boolean
* SearchEnabled Boolean
* SourceFields FieldNameCommaList

$3

* LiteralOptions object: Options for literal field. Present if IndexFieldType specifies the field is of type literal. All options are enabled by default.
* DefaultValue FieldValue
* FacetEnabled Boolean
* ReturnEnabled Boolean
* SearchEnabled Boolean
* SortEnabled Boolean
* SourceField FieldName

$3

* Long integer

$3

* MaximumPartitionCount integer

$3

* MaximumReplicationCount integer

$3

* MultiAZ boolean

$3

* 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.

$3

* OptionStatus object: The status of domain configuration option.
* CreationDate required UpdateTimestamp
* PendingDeletion Boolean
* State required OptionState
* UpdateDate required UpdateTimestamp
* UpdateVersion UIntValue

$3

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

$3

* 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.

$3

* 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.

$3

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

$3

* ScalingParameters object: The desired instance type and desired number of replicas of each index partition.
* DesiredInstanceType PartitionInstanceType
* DesiredPartitionCount UIntValue
* DesiredReplicationCount UIntValue

$3

* ScalingParametersStatus object: The status and configuration of a search domain's scaling parameters.
* Options required ScalingParameters
* Status required OptionStatus

$3

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

$3

* ServiceEndpoint object: The endpoint to which service requests can be submitted.
* Endpoint ServiceUrl

$3

* 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.

$3

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

$3

* StandardNameList array
* items StandardName

$3

* String string

$3

* 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.
* DocumentSuggesterOptions required DocumentSuggesterOptions
* SuggesterName required StandardName

$3

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

$3

* SuggesterStatus object: The value of a Suggester and its current status.
* Options required Suggester
* Status required OptionStatus

$3

* SuggesterStatusList array: Contains the status of multiple suggesters.
* items SuggesterStatus

$3

* 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.
* AnalysisScheme Word
* DefaultValue FieldValue
* HighlightEnabled Boolean
* ReturnEnabled Boolean
* SourceFields FieldNameCommaList

$3

* 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.
* AnalysisScheme Word
* DefaultValue FieldValue
* HighlightEnabled Boolean
* ReturnEnabled Boolean
* SortEnabled Boolean
* SourceField FieldName

$3

* UIntValue integer

$3

* 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.
* DomainName required DomainName
* MultiAZ required Boolean

$3

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

$3

* 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.
* DomainName required DomainName
* ScalingParameters required ScalingParameters

$3

* UpdateScalingParametersResponse object: The result of a UpdateScalingParameters request. Contains the status of the newly-configured scaling parameters.
* ScalingParameters required ScalingParametersStatus

$3

* 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.
* AccessPolicies required PolicyDocument
* DomainName required DomainName

$3

* UpdateServiceAccessPoliciesResponse object: The result of an UpdateServiceAccessPolicies request. Contains the new access policies.
* AccessPolicies required AccessPoliciesStatus

$3

* UpdateTimestamp string

$3

* Word string`