AWS services or capabilities described in AWS Documentation may vary by region/location. Click Getting Started with Amazon AWS to see specific differences applicable to the China (Beijing) Region.
Name | Description | |
---|---|---|
AccessPoliciesStatus | The configured access rules for the domain's document and search endpoints, and the current status of those rules. | |
AnalysisOptions | Synonyms, stopwords, and stemming options for an analysis scheme. Includes tokenization dictionary for Japanese. | |
AnalysisScheme |
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 .
|
|
AnalysisSchemeStatus |
The status and configuration of an AnalysisScheme .
|
|
AvailabilityOptionsStatus | The status and configuration of the domain's availability options. | |
BaseException | CloudSearch exception | |
BuildSuggestersRequest | Container for the parameters to the BuildSuggesters operation. Indexes the search suggestions. For more information, see Configuring Suggesters in the Amazon CloudSearch Developer Guide. | |
BuildSuggestersResponse | Configuration for accessing Amazon BuildSuggesters service | |
BuildSuggestersResult |
The result of a BuildSuggester request. Contains a list of the fields
used for suggestions.
|
|
CreateDomainRequest | Container for the parameters to the CreateDomain operation. Creates a new search domain. For more information, see Creating a Search Domain in the Amazon CloudSearch Developer Guide. | |
CreateDomainResponse | Configuration for accessing Amazon CreateDomain service | |
CreateDomainResult |
The result of a CreateDomainRequest . Contains the status of a newly created
domain.
|
|
DateArrayOptions |
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 |
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 |
Container for the parameters to the DefineAnalysisScheme operation.
Configures an analysis scheme that can be applied to a text or text-array
field to define language-specific text processing options. For more information, see
Configuring Analysis Schemes in the Amazon CloudSearch Developer
Guide.
|
|
DefineAnalysisSchemeResponse | Configuration for accessing Amazon DefineAnalysisScheme service | |
DefineAnalysisSchemeResult |
The result of a DefineAnalysisScheme request. Contains the status
of the newly-configured analysis scheme.
|
|
DefineExpressionRequest |
Container for the parameters to the DefineExpression operation.
Configures an Expression for the search domain. Used to create
new expressions and modify existing ones. If the expression exists, the new configuration
replaces the old one. For more information, see Configuring Expressions in the Amazon CloudSearch Developer
Guide.
|
|
DefineExpressionResponse | Configuration for accessing Amazon DefineExpression service | |
DefineExpressionResult |
The result of a DefineExpression request. Contains the status of the
newly-configured expression.
|
|
DefineIndexFieldRequest |
Container for the parameters to the DefineIndexField operation.
Configures an IndexField for the search domain. Used to create
new fields and modify existing ones. You must specify the name of the domain you are
configuring and an index field configuration. The index field configuration specifies
a unique name, the index field type, and the options you want to configure for the
field. The options you can specify depend on the IndexFieldType .
If the field exists, the new configuration replaces the old one. For more information,
see Configuring Index Fields in the Amazon CloudSearch Developer
Guide.
|
|
DefineIndexFieldResponse | Configuration for accessing Amazon DefineIndexField service | |
DefineIndexFieldResult |
The result of a DefineIndexField request. Contains the status
of the newly-configured index field.
|
|
DefineSuggesterRequest | Container for the parameters to the DefineSuggester operation. Configures a suggester for a domain. A suggester enables you to display possible matches before users finish typing their queries. When you configure a suggester, you must specify the name of the text field you want to search for possible matches and a unique name for the suggester. For more information, see Getting Search Suggestions in the Amazon CloudSearch Developer Guide. | |
DefineSuggesterResponse | Configuration for accessing Amazon DefineSuggester service | |
DefineSuggesterResult |
The result of a DefineSuggester request. Contains the status of the newly-configured
suggester.
|
|
DeleteAnalysisSchemeRequest | Container for the parameters to the DeleteAnalysisScheme operation. Deletes an analysis scheme. For more information, see Configuring Analysis Schemes in the Amazon CloudSearch Developer Guide. | |
DeleteAnalysisSchemeResponse | Configuration for accessing Amazon DeleteAnalysisScheme service | |
DeleteAnalysisSchemeResult |
The result of a DeleteAnalysisScheme request. Contains the status of
the deleted analysis scheme.
|
|
DeleteDomainRequest | Container for the parameters to the DeleteDomain operation. Permanently deletes a search domain and all of its data. Once a domain has been deleted, it cannot be recovered. For more information, see Deleting a Search Domain in the Amazon CloudSearch Developer Guide. | |
DeleteDomainResponse | Configuration for accessing Amazon DeleteDomain service | |
DeleteDomainResult |
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 |
Container for the parameters to the DeleteExpression operation.
Removes an Expression from the search domain. For more information,
see Configuring Expressions in the Amazon CloudSearch Developer
Guide.
|
|
DeleteExpressionResponse | Configuration for accessing Amazon DeleteExpression service | |
DeleteExpressionResult |
The result of a DeleteExpression request. Specifies the expression
being deleted.
|
|
DeleteIndexFieldRequest |
Container for the parameters to the DeleteIndexField operation.
Removes an IndexField from the search domain. For more information,
see Configuring Index Fields in the Amazon CloudSearch Developer
Guide.
|
|
DeleteIndexFieldResponse | Configuration for accessing Amazon DeleteIndexField service | |
DeleteIndexFieldResult |
The result of a DeleteIndexField request.
|
|
DeleteSuggesterRequest | Container for the parameters to the DeleteSuggester operation. Deletes a suggester. For more information, see Getting Search Suggestions in the Amazon CloudSearch Developer Guide. | |
DeleteSuggesterResponse | Configuration for accessing Amazon DeleteSuggester service | |
DeleteSuggesterResult |
The result of a DeleteSuggester request. Contains the status of the deleted
suggester.
|
|
DescribeAnalysisSchemesRequest |
Container for the parameters to the DescribeAnalysisSchemes operation.
Gets the analysis schemes configured for a domain. An analysis scheme defines language-specific
text processing options for a text field. Can be limited to specific
analysis schemes by name. By default, shows all analysis schemes and includes any
pending changes to the configuration. Set the Deployed option to true
to show the active configuration and exclude pending changes. For more information,
see Configuring Analysis Schemes in the Amazon CloudSearch Developer
Guide.
|
|
DescribeAnalysisSchemesResponse | Configuration for accessing Amazon DescribeAnalysisSchemes service | |
DescribeAnalysisSchemesResult |
The result of a DescribeAnalysisSchemes request. Contains the analysis
schemes configured for the domain specified in the request.
|
|
DescribeAvailabilityOptionsRequest |
Container for the parameters to the DescribeAvailabilityOptions operation.
Gets the availability options configured for a domain. By default, shows the configuration
with any pending changes. Set the Deployed option to true
to show the active configuration and exclude pending changes. For more information,
see Configuring Availability Options in the Amazon CloudSearch
Developer Guide.
|
|
DescribeAvailabilityOptionsResponse | Configuration for accessing Amazon DescribeAvailabilityOptions service | |
DescribeAvailabilityOptionsResult |
The result of a DescribeAvailabilityOptions request. Indicates whether
or not the Multi-AZ option is enabled for the domain specified in the request.
|
|
DescribeDomainsRequest |
Container for the parameters to the DescribeDomains operation.
Gets information about the search domains owned by this account. Can be limited to
specific domains. Shows all domains by default. To get the number of searchable documents
in a domain, use the console or submit a matchall request to your domain's
search endpoint: q=matchall&q.parser=structured&size=0 .
For more information, see Getting Information about a Search Domain in the Amazon CloudSearch
Developer Guide.
|
|
DescribeDomainsResponse | Configuration for accessing Amazon DescribeDomains service | |
DescribeDomainsResult |
The result of a DescribeDomains request. Contains the status of the domains
specified in the request or all domains owned by the account.
|
|
DescribeExpressionsRequest |
Container for the parameters to the DescribeExpressions operation.
Gets the expressions configured for the search domain. Can be limited to specific
expressions by name. By default, shows all expressions and includes any pending changes
to the configuration. Set the Deployed option to true to
show the active configuration and exclude pending changes. For more information, see
Configuring Expressions in the Amazon CloudSearch Developer
Guide.
|
|
DescribeExpressionsResponse | Configuration for accessing Amazon DescribeExpressions service | |
DescribeExpressionsResult |
The result of a DescribeExpressions request. Contains the expressions
configured for the domain specified in the request.
|
|
DescribeIndexFieldsRequest |
Container for the parameters to the DescribeIndexFields operation.
Gets information about the index fields configured for the search domain. Can be limited
to specific fields by name. By default, shows all fields and includes any pending
changes to the configuration. Set the Deployed option to true
to show the active configuration and exclude pending changes. For more information,
see Getting Domain Information in the Amazon CloudSearch Developer
Guide.
|
|
DescribeIndexFieldsResponse | Configuration for accessing Amazon DescribeIndexFields service | |
DescribeIndexFieldsResult |
The result of a DescribeIndexFields request. Contains the index fields
configured for the domain specified in the request.
|
|
DescribeScalingParametersRequest | Container for the parameters to the DescribeScalingParameters operation. Gets the scaling parameters configured for a domain. A domain's scaling parameters specify the desired search instance type and replication count. For more information, see Configuring Scaling Options in the Amazon CloudSearch Developer Guide. | |
DescribeScalingParametersResponse | Configuration for accessing Amazon DescribeScalingParameters service | |
DescribeScalingParametersResult |
The result of a DescribeScalingParameters request. Contains the scaling
parameters configured for the domain specified in the request.
|
|
DescribeServiceAccessPoliciesRequest |
Container for the parameters to the DescribeServiceAccessPolicies operation.
Gets information about the access policies that control access to the domain's document
and search endpoints. By default, shows the configuration with any pending changes.
Set the Deployed option to true to show the active configuration
and exclude pending changes. For more information, see Configuring Access for a Search Domain in the Amazon CloudSearch
Developer Guide.
|
|
DescribeServiceAccessPoliciesResponse | Configuration for accessing Amazon DescribeServiceAccessPolicies service | |
DescribeServiceAccessPoliciesResult |
The result of a DescribeServiceAccessPolicies request.
|
|
DescribeSuggestersRequest |
Container for the parameters to the DescribeSuggesters operation.
Gets the suggesters configured for a domain. A suggester enables you to display possible
matches before users finish typing their queries. Can be limited to specific suggesters
by name. By default, shows all suggesters and includes any pending changes to the
configuration. Set the Deployed option to true to show the
active configuration and exclude pending changes. For more information, see Getting Search Suggestions in the Amazon CloudSearch Developer
Guide.
|
|
DescribeSuggestersResponse | Configuration for accessing Amazon DescribeSuggesters service | |
DescribeSuggestersResult |
The result of a DescribeSuggesters request.
|
|
DisabledOperationException | CloudSearch exception | |
DocumentSuggesterOptions | Options for a search suggester. | |
DomainStatus | The current status of the search domain. | |
DoubleArrayOptions |
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 |
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.
|
|
Expression | 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 |
The value of an Expression and its current status.
|
|
IndexDocumentsRequest |
Container for the parameters to the IndexDocuments operation.
Tells the search domain to start indexing its documents using the latest indexing
options. This operation must be invoked to activate options whose OptionStatus
is RequiresIndexDocuments .
|
|
IndexDocumentsResponse | Configuration for accessing Amazon IndexDocuments service | |
IndexDocumentsResult |
The result of an IndexDocuments request. Contains the status of the indexing
operation, including the fields being indexed.
|
|
IndexField |
Configuration information for a field in the index, including its name, type, and
options. The supported options depend on the IndexFieldType .
|
|
IndexFieldStatus |
The value of an IndexField and its current status.
|
|
IntArrayOptions |
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.
|
|
InternalException | CloudSearch exception | |
IntOptions |
Options for a 64-bit signed integer field. Present if IndexFieldType
specifies the field is of type int . All options are enabled by default.
|
|
InvalidTypeException | CloudSearch exception | |
LatLonOptions |
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 | CloudSearch exception | |
Limits | ||
ListDomainNamesRequest | Container for the parameters to the ListDomainNames operation. Lists all search domains owned by an account. | |
ListDomainNamesResponse | Configuration for accessing Amazon ListDomainNames service | |
ListDomainNamesResult |
The result of a ListDomainNames request. Contains a list of the domains
owned by an account.
|
|
LiteralArrayOptions |
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 |
Options for literal field. Present if IndexFieldType specifies the field
is of type literal . All options are enabled by default.
|
|
OptionStatus | The status of domain configuration option. | |
ResourceNotFoundException | CloudSearch exception | |
ScalingParameters | The desired instance type and desired number of replicas of each index partition. | |
ScalingParametersStatus | The status and configuration of a search domain's scaling parameters. | |
ServiceEndpoint | The endpoint to which service requests can be submitted. | |
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 .
|
|
SuggesterStatus |
The value of a Suggester and its current status.
|
|
TextArrayOptions |
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 |
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.
|
|
UpdateAvailabilityOptionsRequest | Container for the parameters to the UpdateAvailabilityOptions operation. Configures the availability options for a domain. Enabling the Multi-AZ option expands an Amazon CloudSearch domain to an additional Availability Zone in the same Region to increase fault tolerance in the event of a service disruption. Changes to the Multi-AZ option can take about half an hour to become active. For more information, see Configuring Availability Options in the Amazon CloudSearch Developer Guide. | |
UpdateAvailabilityOptionsResponse | Configuration for accessing Amazon UpdateAvailabilityOptions service | |
UpdateAvailabilityOptionsResult |
The result of a UpdateAvailabilityOptions request. Contains the status
of the domain's availability options.
|
|
UpdateScalingParametersRequest | Container for the parameters to the UpdateScalingParameters operation. Configures scaling parameters for a domain. A domain's scaling parameters specify the desired search instance type and replication count. Amazon CloudSearch will still automatically scale your domain based on the volume of data and traffic, but not below the desired instance type and replication count. If the Multi-AZ option is enabled, these values control the resources used per Availability Zone. For more information, see Configuring Scaling Options in the Amazon CloudSearch Developer Guide. | |
UpdateScalingParametersResponse | Configuration for accessing Amazon UpdateScalingParameters service | |
UpdateScalingParametersResult |
The result of a UpdateScalingParameters request. Contains the status
of the newly-configured scaling parameters.
|
|
UpdateServiceAccessPoliciesRequest | Container for the parameters to the UpdateServiceAccessPolicies operation. Configures the access rules that control access to the domain's document and search endpoints. For more information, see Configuring Access for an Amazon CloudSearch Domain. | |
UpdateServiceAccessPoliciesResponse | Configuration for accessing Amazon UpdateServiceAccessPolicies service | |
UpdateServiceAccessPoliciesResult |
The result of an UpdateServiceAccessPolicies request. Contains the new
access policies.
|