Package-level declarations

Types

Link copied to clipboard

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

Link copied to clipboard
sealed class AlgorithmicStemming
Link copied to clipboard

Synonyms, stopwords, and stemming options for an analysis scheme. Includes tokenization dictionary for Japanese.

Link copied to clipboard

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.

Link copied to clipboard

An IETF RFC 4646 language code or mul for multiple languages.

Link copied to clipboard

The status and configuration of an AnalysisScheme.

Link copied to clipboard

The status and configuration of the domain's availability options.

Link copied to clipboard

An error occurred while processing the request.

Link copied to clipboard

Container for the parameters to the <a>BuildSuggester</a> operation. Specifies the name of the domain you want to update.

Link copied to clipboard

The result of a BuildSuggester request. Contains a list of the fields used for suggestions.

Link copied to clipboard

Base class for all service related exceptions thrown by the CloudSearch client

Link copied to clipboard

Container for the parameters to the <a>CreateDomain</a> operation. Specifies a name for the new search domain.

Link copied to clipboard

The result of a CreateDomainRequest. Contains the status of a newly created domain.

Link copied to clipboard

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.

Link copied to clipboard

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.

Link copied to clipboard

Container for the parameters to the <a>DefineAnalysisScheme</a> operation. Specifies the name of the domain you want to update and the analysis scheme configuration.

Link copied to clipboard

The result of a <a>DefineAnalysisScheme</a> request. Contains the status of the newly-configured analysis scheme.

Link copied to clipboard

Container for the parameters to the <a>DefineExpression</a> operation. Specifies the name of the domain you want to update and the expression you want to configure.

Link copied to clipboard

The result of a DefineExpression request. Contains the status of the newly-configured expression.

Link copied to clipboard

Container for the parameters to the <a>DefineIndexField</a> operation. Specifies the name of the domain you want to update and the index field configuration.

Link copied to clipboard

The result of a <a>DefineIndexField</a> request. Contains the status of the newly-configured index field.

Link copied to clipboard

Container for the parameters to the <a>DefineSuggester</a> operation. Specifies the name of the domain you want to update and the suggester configuration.

Link copied to clipboard

The result of a DefineSuggester request. Contains the status of the newly-configured suggester.

Link copied to clipboard

Container for the parameters to the <a>DeleteAnalysisScheme</a> operation. Specifies the name of the domain you want to update and the analysis scheme you want to delete.

Link copied to clipboard

The result of a DeleteAnalysisScheme request. Contains the status of the deleted analysis scheme.

Link copied to clipboard

Container for the parameters to the <a>DeleteDomain</a> operation. Specifies the name of the domain you want to delete.

Link copied to clipboard

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.

Link copied to clipboard

Container for the parameters to the <a>DeleteExpression</a> operation. Specifies the name of the domain you want to update and the name of the expression you want to delete.

Link copied to clipboard

The result of a <a>DeleteExpression</a> request. Specifies the expression being deleted.

Link copied to clipboard

Container for the parameters to the <a>DeleteIndexField</a> operation. Specifies the name of the domain you want to update and the name of the index field you want to delete.

Link copied to clipboard

The result of a <a>DeleteIndexField</a> request.

Link copied to clipboard

Container for the parameters to the <a>DeleteSuggester</a> operation. Specifies the name of the domain you want to update and name of the suggester you want to delete.

Link copied to clipboard

The result of a DeleteSuggester request. Contains the status of the deleted suggester.

Link copied to clipboard

Container for the parameters to the <a>DescribeAnalysisSchemes</a> 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.

Link copied to clipboard

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

Link copied to clipboard

Container for the parameters to the <a>DescribeAvailabilityOptions</a> 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.

Link copied to clipboard

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

Link copied to clipboard

Container for the parameters to the <a>DescribeDomainEndpointOptions</a> operation. Specify 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.

Link copied to clipboard

The result of a DescribeDomainEndpointOptions request. Contains the status and configuration of a search domain's endpoint options.

Link copied to clipboard

Container for the parameters to the <a>DescribeDomains</a> 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.

Link copied to clipboard

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

Link copied to clipboard

Container for the parameters to the <a>DescribeDomains</a> 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.

Link copied to clipboard

The result of a DescribeExpressions request. Contains the expressions configured for the domain specified in the request.

Link copied to clipboard

Container for the parameters to the <a>DescribeIndexFields</a> 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.

Link copied to clipboard

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

Link copied to clipboard

Container for the parameters to the <a>DescribeScalingParameters</a> operation. Specifies the name of the domain you want to describe.

Link copied to clipboard

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

Link copied to clipboard

Container for the parameters to the <a>DescribeServiceAccessPolicies</a> 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.

Link copied to clipboard

The result of a DescribeServiceAccessPolicies request.

Link copied to clipboard

Container for the parameters to the <a>DescribeSuggester</a> 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.

Link copied to clipboard

The result of a DescribeSuggesters request.

Link copied to clipboard

The request was rejected because it attempted an operation which is not enabled.

Link copied to clipboard

Options for a search suggester.

Link copied to clipboard

The domain's endpoint options.

Link copied to clipboard

The configuration and status of the domain's endpoint options.

Link copied to clipboard

The current status of the search domain.

Link copied to clipboard

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.

Link copied to clipboard

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.

Link copied to clipboard

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.

Link copied to clipboard

The value of an Expression and its current status.

Link copied to clipboard

Container for the parameters to the <a>IndexDocuments</a> operation. Specifies the name of the domain you want to re-index.

Link copied to clipboard

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

Link copied to clipboard

Configuration information for a field in the index, including its name, type, and options. The supported options depend on the <a>IndexFieldType</a>.

Link copied to clipboard

The value of an IndexField and its current status.

Link copied to clipboard
sealed class IndexFieldType

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.

Link copied to clipboard

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.

Link copied to clipboard

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

Link copied to clipboard

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

Link copied to clipboard

The request was rejected because it specified an invalid type definition.

Link copied to clipboard

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.

Link copied to clipboard

The request was rejected because a resource limit has already been met.

Link copied to clipboard
class Limits
Link copied to clipboard
Link copied to clipboard

The result of a ListDomainNames request. Contains a list of the domains owned by an account.

Link copied to clipboard

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.

Link copied to clipboard

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

Link copied to clipboard
sealed class OptionState

The state of processing a change to an option. One of:

Link copied to clipboard

The status of domain configuration option.

Link copied to clipboard

The instance type (such as search.m1.small) on which an index partition is hosted.

Link copied to clipboard

The request was rejected because it attempted to create a resource that already exists.

Link copied to clipboard

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

Link copied to clipboard

The desired instance type and desired number of replicas of each index partition.

Link copied to clipboard

The status and configuration of a search domain's scaling parameters.

Link copied to clipboard

The endpoint to which service requests can be submitted.

Link copied to clipboard
class Suggester

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.

Link copied to clipboard
Link copied to clipboard

The value of a Suggester and its current status.

Link copied to clipboard

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.

Link copied to clipboard

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.

Link copied to clipboard
sealed class TlsSecurityPolicy

The minimum required TLS version.

Link copied to clipboard

Container for the parameters to the <a>UpdateAvailabilityOptions</a> operation. Specifies the name of the domain you want to update and the Multi-AZ availability option.

Link copied to clipboard

The result of a UpdateAvailabilityOptions request. Contains the status of the domain's availability options.

Link copied to clipboard

Container for the parameters to the <a>UpdateDomainEndpointOptions</a> operation. Specifies the name of the domain you want to update and the domain endpoint options.

Link copied to clipboard

The result of a UpdateDomainEndpointOptions request. Contains the configuration and status of the domain's endpoint options.

Link copied to clipboard

Container for the parameters to the <a>UpdateScalingParameters</a> operation. Specifies the name of the domain you want to update and the scaling parameters you want to configure.

Link copied to clipboard

The result of a UpdateScalingParameters request. Contains the status of the newly-configured scaling parameters.

Link copied to clipboard

Container for the parameters to the <a>UpdateServiceAccessPolicies</a> operation. Specifies the name of the domain you want to update and the access rules you want to configure.

Link copied to clipboard

The result of an UpdateServiceAccessPolicies request. Contains the new access policies.

Link copied to clipboard

The request was rejected because it has invalid parameters.