ExAws.Cloudsearch.Core
Amazon CloudSearch
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.
Summary↑
Types ↑
index_field_type :: binary
domain_name_map :: [{domain_name, api_version}]
field_name_comma_list :: binary
access_policies_status :: [options: policy_document, status: option_status]
date_array_options :: [default_value: field_value, facet_enabled: boolean, return_enabled: boolean, search_enabled: boolean, source_fields: field_name_comma_list]
invalid_type_exception :: []
scaling_parameters_status :: [options: scaling_parameters, status: option_status]
document_suggester_options :: [fuzzy_matching: suggester_fuzzy_matching, sort_expression: binary, source_field: field_name]
update_service_access_policies_response :: [{:access_policies, access_policies_status}]
describe_suggesters_response :: [{:suggesters, suggester_status_list}]
double_array_options :: [default_value: double, facet_enabled: boolean, return_enabled: boolean, search_enabled: boolean, source_fields: field_name_comma_list]
error_message :: binary
expression :: [expression_name: standard_name, expression_value: expression_value]
describe_service_access_policies_request :: [deployed: boolean, domain_name: domain_name]
create_domain_request :: [{:domain_name, domain_name}]
update_timestamp :: integer
internal_exception :: []
describe_service_access_policies_response :: [{:access_policies, access_policies_status}]
multi_az :: boolean
index_documents_request :: [{:domain_name, domain_name}]
literal_options :: [default_value: field_value, facet_enabled: boolean, return_enabled: boolean, search_enabled: boolean, sort_enabled: boolean, source_field: field_name]
describe_scaling_parameters_response :: [{:scaling_parameters, scaling_parameters_status}]
dynamic_field_name :: binary
partition_instance_type :: binary
create_domain_response :: [{:domain_status, domain_status}]
literal_array_options :: [default_value: field_value, facet_enabled: boolean, return_enabled: boolean, search_enabled: boolean, source_fields: field_name_comma_list]
define_index_field_request :: [domain_name: domain_name, index_field: index_field]
arn :: binary
delete_index_field_response :: [{:index_field, index_field_status}]
domain_id :: binary
index_field_status :: [options: index_field, status: option_status]
algorithmic_stemming :: binary
expression_status :: [options: expression, status: option_status]
word :: binary
date_options :: [default_value: field_value, facet_enabled: boolean, return_enabled: boolean, search_enabled: boolean, sort_enabled: boolean, source_field: field_name]
update_scaling_parameters_request :: [domain_name: domain_name, scaling_parameters: scaling_parameters]
double_options :: [default_value: double, facet_enabled: boolean, return_enabled: boolean, search_enabled: boolean, sort_enabled: boolean, source_field: field_name]
describe_availability_options_request :: [deployed: boolean, domain_name: domain_name]
error_code :: binary
index_documents_response :: [{:field_names, field_name_list}]
limits :: [maximum_partition_count: maximum_partition_count, maximum_replication_count: maximum_replication_count]
delete_expression_request :: [domain_name: domain_name, expression_name: standard_name]
suggester_fuzzy_matching :: binary
search_instance_type :: binary
describe_domains_response :: [{:domain_status_list, domain_status_list}]
domain_name :: binary
describe_expressions_request :: [deployed: boolean, domain_name: domain_name, expression_names: standard_name_list]
analysis_scheme_status :: [options: analysis_scheme, status: option_status]
build_suggesters_request :: [{:domain_name, domain_name}]
delete_expression_response :: [{:expression, expression_status}]
describe_suggesters_request :: [deployed: boolean, domain_name: domain_name, suggester_names: standard_name_list]
partition_count :: integer
describe_analysis_schemes_response :: [{:analysis_schemes, analysis_scheme_status_list}]
update_service_access_policies_request :: [access_policies: policy_document, domain_name: domain_name]
service_url :: binary
define_analysis_scheme_request :: [analysis_scheme: analysis_scheme, domain_name: domain_name]
suggester_status :: [options: suggester, status: option_status]
analysis_options :: [algorithmic_stemming: algorithmic_stemming, japanese_tokenization_dictionary: binary, stemming_dictionary: binary, stopwords: binary, synonyms: binary]
define_suggester_request :: [domain_name: domain_name, suggester: suggester]
update_scaling_parameters_response :: [{:scaling_parameters, scaling_parameters_status}]
double :: float
delete_suggester_request :: [domain_name: domain_name, suggester_name: standard_name]
describe_availability_options_response :: [{:availability_options, availability_options_status}]
option_state :: binary
u_int_value :: integer
define_analysis_scheme_response :: [{:analysis_scheme, analysis_scheme_status}]
define_suggester_response :: [{:suggester, suggester_status}]
instance_count :: integer
limit_exceeded_exception :: []
availability_options_status :: [options: multi_az, status: option_status]
update_availability_options_response :: [{:availability_options, availability_options_status}]
describe_index_fields_response :: [{:index_fields, index_field_status_list}]
long :: integer
delete_domain_request :: [{:domain_name, domain_name}]
api_version :: binary
describe_scaling_parameters_request :: [{:domain_name, domain_name}]
describe_expressions_response :: [{:expressions, expression_status_list}]
maximum_replication_count :: integer
policy_document :: binary
lat_lon_options :: [default_value: field_value, facet_enabled: boolean, return_enabled: boolean, search_enabled: boolean, sort_enabled: boolean, source_field: field_name]
describe_domains_request :: [{:domain_names, domain_name_list}]
list_domain_names_response :: [{:domain_names, domain_name_map}]
index_field :: [date_array_options: date_array_options, date_options: date_options, double_array_options: double_array_options, double_options: double_options, index_field_name: dynamic_field_name, index_field_type: index_field_type, int_array_options: int_array_options, int_options: int_options, lat_lon_options: lat_lon_options, literal_array_options: literal_array_options, literal_options: literal_options, text_array_options: text_array_options, text_options: text_options]
delete_domain_response :: [{:domain_status, domain_status}]
int_array_options :: [default_value: long, facet_enabled: boolean, return_enabled: boolean, search_enabled: boolean, source_fields: field_name_comma_list]
text_options :: [analysis_scheme: word, default_value: field_value, highlight_enabled: boolean, return_enabled: boolean, sort_enabled: boolean, source_field: field_name]
base_exception :: [code: error_code, message: error_message]
define_index_field_response :: [{:index_field, index_field_status}]
text_array_options :: [analysis_scheme: word, default_value: field_value, highlight_enabled: boolean, return_enabled: boolean, source_fields: field_name_comma_list]
analysis_scheme :: [analysis_options: analysis_options, analysis_scheme_language: analysis_scheme_language, analysis_scheme_name: standard_name]
describe_index_fields_request :: [deployed: boolean, domain_name: domain_name, field_names: dynamic_field_name_list]
scaling_parameters :: [desired_instance_type: partition_instance_type, desired_partition_count: u_int_value, desired_replication_count: u_int_value]
suggester :: [document_suggester_options: document_suggester_options, suggester_name: standard_name]
define_expression_request :: [domain_name: domain_name, expression: expression]
service_endpoint :: [{:endpoint, service_url}]
field_value :: binary
delete_analysis_scheme_request :: [analysis_scheme_name: standard_name, domain_name: domain_name]
delete_suggester_response :: [{:suggester, suggester_status}]
update_availability_options_request :: [domain_name: domain_name, multi_az: boolean]
delete_index_field_request :: [domain_name: domain_name, index_field_name: dynamic_field_name]
int_options :: [default_value: long, facet_enabled: boolean, return_enabled: boolean, search_enabled: boolean, sort_enabled: boolean, source_field: field_name]
expression_value :: binary
option_status :: [creation_date: update_timestamp, pending_deletion: boolean, state: option_state, update_date: update_timestamp, update_version: u_int_value]
define_expression_response :: [{:expression, expression_status}]
describe_analysis_schemes_request :: [analysis_scheme_names: standard_name_list, deployed: boolean, domain_name: domain_name]
build_suggesters_response :: [{:field_names, field_name_list}]
domain_status :: [arn: arn, created: boolean, deleted: boolean, doc_service: service_endpoint, domain_id: domain_id, domain_name: domain_name, limits: limits, processing: boolean, requires_index_documents: boolean, search_instance_count: instance_count, search_instance_type: search_instance_type, search_partition_count: partition_count, search_service: service_endpoint]
analysis_scheme_language :: binary
maximum_partition_count :: integer
standard_name :: binary
field_name :: binary
delete_analysis_scheme_response :: [{:analysis_scheme, analysis_scheme_status}]
Functions
Specs:
- build_suggesters(client :: ExAws.Cloudsearch.t, input :: build_suggesters_request) :: ExAws.Request.Query.response_t
BuildSuggesters
Indexes the search suggestions. For more information, see Configuring Suggesters in the Amazon CloudSearch Developer Guide.
Specs:
- build_suggesters!(client :: ExAws.Cloudsearch.t, input :: build_suggesters_request) :: ExAws.Request.Query.success_t | no_return
Same as build_suggesters/2
but raise on error.
Specs:
- create_domain(client :: ExAws.Cloudsearch.t, input :: create_domain_request) :: ExAws.Request.Query.response_t
CreateDomain
Creates a new search domain. For more information, see Creating a Search Domain in the Amazon CloudSearch Developer Guide.
Specs:
- create_domain!(client :: ExAws.Cloudsearch.t, input :: create_domain_request) :: ExAws.Request.Query.success_t | no_return
Same as create_domain/2
but raise on error.
Specs:
- define_analysis_scheme(client :: ExAws.Cloudsearch.t, input :: define_analysis_scheme_request) :: ExAws.Request.Query.response_t
DefineAnalysisScheme
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.
Specs:
- define_analysis_scheme!(client :: ExAws.Cloudsearch.t, input :: define_analysis_scheme_request) :: ExAws.Request.Query.success_t | no_return
Same as define_analysis_scheme/2
but raise on error.
Specs:
- define_expression(client :: ExAws.Cloudsearch.t, input :: define_expression_request) :: ExAws.Request.Query.response_t
DefineExpression
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.
Specs:
- define_expression!(client :: ExAws.Cloudsearch.t, input :: define_expression_request) :: ExAws.Request.Query.success_t | no_return
Same as define_expression/2
but raise on error.
Specs:
- define_index_field(client :: ExAws.Cloudsearch.t, input :: define_index_field_request) :: ExAws.Request.Query.response_t
DefineIndexField
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.
Specs:
- define_index_field!(client :: ExAws.Cloudsearch.t, input :: define_index_field_request) :: ExAws.Request.Query.success_t | no_return
Same as define_index_field/2
but raise on error.
Specs:
- define_suggester(client :: ExAws.Cloudsearch.t, input :: define_suggester_request) :: ExAws.Request.Query.response_t
DefineSuggester
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.
Specs:
- define_suggester!(client :: ExAws.Cloudsearch.t, input :: define_suggester_request) :: ExAws.Request.Query.success_t | no_return
Same as define_suggester/2
but raise on error.
Specs:
- delete_analysis_scheme(client :: ExAws.Cloudsearch.t, input :: delete_analysis_scheme_request) :: ExAws.Request.Query.response_t
DeleteAnalysisScheme
Deletes an analysis scheme. For more information, see Configuring Analysis Schemes in the Amazon CloudSearch Developer Guide.
Specs:
- delete_analysis_scheme!(client :: ExAws.Cloudsearch.t, input :: delete_analysis_scheme_request) :: ExAws.Request.Query.success_t | no_return
Same as delete_analysis_scheme/2
but raise on error.
Specs:
- delete_domain(client :: ExAws.Cloudsearch.t, input :: delete_domain_request) :: ExAws.Request.Query.response_t
DeleteDomain
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.
Specs:
- delete_domain!(client :: ExAws.Cloudsearch.t, input :: delete_domain_request) :: ExAws.Request.Query.success_t | no_return
Same as delete_domain/2
but raise on error.
Specs:
- delete_expression(client :: ExAws.Cloudsearch.t, input :: delete_expression_request) :: ExAws.Request.Query.response_t
DeleteExpression
Removes an Expression
from the search domain. For more information, see
Configuring
Expressions in the Amazon CloudSearch Developer Guide.
Specs:
- delete_expression!(client :: ExAws.Cloudsearch.t, input :: delete_expression_request) :: ExAws.Request.Query.success_t | no_return
Same as delete_expression/2
but raise on error.
Specs:
- delete_index_field(client :: ExAws.Cloudsearch.t, input :: delete_index_field_request) :: ExAws.Request.Query.response_t
DeleteIndexField
Removes an IndexField
from the search domain. For more information, see
Configuring Index
Fields in the Amazon CloudSearch Developer Guide.
Specs:
- delete_index_field!(client :: ExAws.Cloudsearch.t, input :: delete_index_field_request) :: ExAws.Request.Query.success_t | no_return
Same as delete_index_field/2
but raise on error.
Specs:
- delete_suggester(client :: ExAws.Cloudsearch.t, input :: delete_suggester_request) :: ExAws.Request.Query.response_t
DeleteSuggester
Deletes a suggester. For more information, see Getting Search Suggestions in the Amazon CloudSearch Developer Guide.
Specs:
- delete_suggester!(client :: ExAws.Cloudsearch.t, input :: delete_suggester_request) :: ExAws.Request.Query.success_t | no_return
Same as delete_suggester/2
but raise on error.
Specs:
- describe_analysis_schemes(client :: ExAws.Cloudsearch.t, input :: describe_analysis_schemes_request) :: ExAws.Request.Query.response_t
DescribeAnalysisSchemes
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.
Specs:
- describe_analysis_schemes!(client :: ExAws.Cloudsearch.t, input :: describe_analysis_schemes_request) :: ExAws.Request.Query.success_t | no_return
Same as describe_analysis_schemes/2
but raise on error.
Specs:
- describe_availability_options(client :: ExAws.Cloudsearch.t, input :: describe_availability_options_request) :: ExAws.Request.Query.response_t
DescribeAvailabilityOptions
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.
Specs:
- describe_availability_options!(client :: ExAws.Cloudsearch.t, input :: describe_availability_options_request) :: ExAws.Request.Query.success_t | no_return
Same as describe_availability_options/2
but raise on error.
Specs:
- describe_domains(client :: ExAws.Cloudsearch.t, input :: describe_domains_request) :: ExAws.Request.Query.response_t
DescribeDomains
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.
Specs:
- describe_domains!(client :: ExAws.Cloudsearch.t, input :: describe_domains_request) :: ExAws.Request.Query.success_t | no_return
Same as describe_domains/2
but raise on error.
Specs:
- describe_expressions(client :: ExAws.Cloudsearch.t, input :: describe_expressions_request) :: ExAws.Request.Query.response_t
DescribeExpressions
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.
Specs:
- describe_expressions!(client :: ExAws.Cloudsearch.t, input :: describe_expressions_request) :: ExAws.Request.Query.success_t | no_return
Same as describe_expressions/2
but raise on error.
Specs:
- describe_index_fields(client :: ExAws.Cloudsearch.t, input :: describe_index_fields_request) :: ExAws.Request.Query.response_t
DescribeIndexFields
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.
Specs:
- describe_index_fields!(client :: ExAws.Cloudsearch.t, input :: describe_index_fields_request) :: ExAws.Request.Query.success_t | no_return
Same as describe_index_fields/2
but raise on error.
Specs:
- describe_scaling_parameters(client :: ExAws.Cloudsearch.t, input :: describe_scaling_parameters_request) :: ExAws.Request.Query.response_t
DescribeScalingParameters
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.
Specs:
- describe_scaling_parameters!(client :: ExAws.Cloudsearch.t, input :: describe_scaling_parameters_request) :: ExAws.Request.Query.success_t | no_return
Same as describe_scaling_parameters/2
but raise on error.
Specs:
- describe_service_access_policies(client :: ExAws.Cloudsearch.t, input :: describe_service_access_policies_request) :: ExAws.Request.Query.response_t
DescribeServiceAccessPolicies
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.
Specs:
- describe_service_access_policies!(client :: ExAws.Cloudsearch.t, input :: describe_service_access_policies_request) :: ExAws.Request.Query.success_t | no_return
Same as describe_service_access_policies/2
but raise on error.
Specs:
- describe_suggesters(client :: ExAws.Cloudsearch.t, input :: describe_suggesters_request) :: ExAws.Request.Query.response_t
DescribeSuggesters
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.
Specs:
- describe_suggesters!(client :: ExAws.Cloudsearch.t, input :: describe_suggesters_request) :: ExAws.Request.Query.success_t | no_return
Same as describe_suggesters/2
but raise on error.
Specs:
- index_documents(client :: ExAws.Cloudsearch.t, input :: index_documents_request) :: ExAws.Request.Query.response_t
IndexDocuments
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
.
Specs:
- index_documents!(client :: ExAws.Cloudsearch.t, input :: index_documents_request) :: ExAws.Request.Query.success_t | no_return
Same as index_documents/2
but raise on error.
Specs:
- list_domain_names(client :: ExAws.Cloudsearch.t) :: ExAws.Request.Query.response_t
ListDomainNames
Lists all search domains owned by an account.
Specs:
- list_domain_names!(client :: ExAws.Cloudsearch.t) :: ExAws.Request.Query.success_t | no_return
Same as list_domain_names/2
but raise on error.
Specs:
- update_availability_options(client :: ExAws.Cloudsearch.t, input :: update_availability_options_request) :: ExAws.Request.Query.response_t
UpdateAvailabilityOptions
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.
Specs:
- update_availability_options!(client :: ExAws.Cloudsearch.t, input :: update_availability_options_request) :: ExAws.Request.Query.success_t | no_return
Same as update_availability_options/2
but raise on error.
Specs:
- update_scaling_parameters(client :: ExAws.Cloudsearch.t, input :: update_scaling_parameters_request) :: ExAws.Request.Query.response_t
UpdateScalingParameters
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.
Specs:
- update_scaling_parameters!(client :: ExAws.Cloudsearch.t, input :: update_scaling_parameters_request) :: ExAws.Request.Query.success_t | no_return
Same as update_scaling_parameters/2
but raise on error.
Specs:
- update_service_access_policies(client :: ExAws.Cloudsearch.t, input :: update_service_access_policies_request) :: ExAws.Request.Query.response_t
UpdateServiceAccessPolicies
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.
Specs:
- update_service_access_policies!(client :: ExAws.Cloudsearch.t, input :: update_service_access_policies_request) :: ExAws.Request.Query.success_t | no_return
Same as update_service_access_policies/2
but raise on error.