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.

Source

Summary

build_suggesters!(client, input)

Same as build_suggesters/2 but raise on error

build_suggesters(client, input)

BuildSuggesters

create_domain!(client, input)

Same as create_domain/2 but raise on error

create_domain(client, input)

CreateDomain

define_analysis_scheme!(client, input)

Same as define_analysis_scheme/2 but raise on error

define_analysis_scheme(client, input)

DefineAnalysisScheme

define_expression!(client, input)

Same as define_expression/2 but raise on error

define_expression(client, input)

DefineExpression

define_index_field!(client, input)

Same as define_index_field/2 but raise on error

define_index_field(client, input)

DefineIndexField

define_suggester!(client, input)

Same as define_suggester/2 but raise on error

define_suggester(client, input)

DefineSuggester

delete_analysis_scheme!(client, input)

Same as delete_analysis_scheme/2 but raise on error

delete_analysis_scheme(client, input)

DeleteAnalysisScheme

delete_domain!(client, input)

Same as delete_domain/2 but raise on error

delete_domain(client, input)

DeleteDomain

delete_expression!(client, input)

Same as delete_expression/2 but raise on error

delete_expression(client, input)

DeleteExpression

delete_index_field!(client, input)

Same as delete_index_field/2 but raise on error

delete_index_field(client, input)

DeleteIndexField

delete_suggester!(client, input)

Same as delete_suggester/2 but raise on error

delete_suggester(client, input)

DeleteSuggester

describe_analysis_schemes!(client, input)

Same as describe_analysis_schemes/2 but raise on error

describe_analysis_schemes(client, input)

DescribeAnalysisSchemes

describe_availability_options!(client, input)

Same as describe_availability_options/2 but raise on error

describe_availability_options(client, input)

DescribeAvailabilityOptions

describe_domains!(client, input)

Same as describe_domains/2 but raise on error

describe_domains(client, input)

DescribeDomains

describe_expressions!(client, input)

Same as describe_expressions/2 but raise on error

describe_expressions(client, input)

DescribeExpressions

describe_index_fields!(client, input)

Same as describe_index_fields/2 but raise on error

describe_index_fields(client, input)

DescribeIndexFields

describe_scaling_parameters!(client, input)

Same as describe_scaling_parameters/2 but raise on error

describe_scaling_parameters(client, input)

DescribeScalingParameters

describe_service_access_policies!(client, input)

Same as describe_service_access_policies/2 but raise on error

describe_service_access_policies(client, input)

DescribeServiceAccessPolicies

describe_suggesters!(client, input)

Same as describe_suggesters/2 but raise on error

describe_suggesters(client, input)

DescribeSuggesters

index_documents!(client, input)

Same as index_documents/2 but raise on error

index_documents(client, input)

IndexDocuments

list_domain_names!(client)

Same as list_domain_names/2 but raise on error

list_domain_names(client)

ListDomainNames

update_availability_options!(client, input)

Same as update_availability_options/2 but raise on error

update_availability_options(client, input)

UpdateAvailabilityOptions

update_scaling_parameters!(client, input)

Same as update_scaling_parameters/2 but raise on error

update_scaling_parameters(client, input)

UpdateScalingParameters

update_service_access_policies!(client, input)

Same as update_service_access_policies/2 but raise on error

update_service_access_policies(client, input)

UpdateServiceAccessPolicies

Types

index_field_type :: binary

date_array_options :: [default_value: field_value, facet_enabled: boolean, return_enabled: boolean, search_enabled: boolean, source_fields: field_name_comma_list]

document_suggester_options :: [fuzzy_matching: suggester_fuzzy_matching, sort_expression: binary, source_field: field_name]

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

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]

dynamic_field_name :: 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

domain_id :: 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

limits :: [maximum_partition_count: maximum_partition_count, maximum_replication_count: maximum_replication_count]

delete_expression_request :: [domain_name: domain_name, expression_name: standard_name]

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]

build_suggesters_request :: [{:domain_name, domain_name}]

describe_suggesters_request :: [deployed: boolean, domain_name: domain_name, suggester_names: standard_name_list]

partition_count :: integer

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]

double :: float

delete_suggester_request :: [domain_name: domain_name, suggester_name: standard_name]

option_state :: binary

u_int_value :: integer

instance_count :: integer

long :: integer

delete_domain_request :: [{:domain_name, domain_name}]

api_version :: binary

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]

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]

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]

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]

describe_analysis_schemes_request :: [analysis_scheme_names: standard_name_list, deployed: boolean, domain_name: domain_name]

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]

standard_name :: binary

field_name :: binary

Functions

build_suggesters(client, input)

Specs:

BuildSuggesters

Indexes the search suggestions. For more information, see Configuring Suggesters in the Amazon CloudSearch Developer Guide.

Source
build_suggesters!(client, input)

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.

Source
create_domain(client, input)

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.

Source
create_domain!(client, input)

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.

Source
define_analysis_scheme(client, input)

Specs:

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.

Source
define_analysis_scheme!(client, input)

Specs:

Same as define_analysis_scheme/2 but raise on error.

Source
define_expression(client, input)

Specs:

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.

Source
define_expression!(client, input)

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.

Source
define_index_field(client, input)

Specs:

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.

Source
define_index_field!(client, input)

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.

Source
define_suggester(client, input)

Specs:

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.

Source
define_suggester!(client, input)

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.

Source
delete_analysis_scheme(client, input)

Specs:

DeleteAnalysisScheme

Deletes an analysis scheme. For more information, see Configuring Analysis Schemes in the Amazon CloudSearch Developer Guide.

Source
delete_analysis_scheme!(client, input)

Specs:

Same as delete_analysis_scheme/2 but raise on error.

Source
delete_domain(client, input)

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.

Source
delete_domain!(client, input)

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.

Source
delete_expression(client, input)

Specs:

DeleteExpression

Removes an Expression from the search domain. For more information, see Configuring Expressions in the Amazon CloudSearch Developer Guide.

Source
delete_expression!(client, input)

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.

Source
delete_index_field(client, input)

Specs:

DeleteIndexField

Removes an IndexField from the search domain. For more information, see Configuring Index Fields in the Amazon CloudSearch Developer Guide.

Source
delete_index_field!(client, input)

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.

Source
delete_suggester(client, input)

Specs:

DeleteSuggester

Deletes a suggester. For more information, see Getting Search Suggestions in the Amazon CloudSearch Developer Guide.

Source
delete_suggester!(client, input)

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.

Source
describe_analysis_schemes(client, input)

Specs:

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.

Source
describe_analysis_schemes!(client, input)

Specs:

Same as describe_analysis_schemes/2 but raise on error.

Source
describe_availability_options(client, input)

Specs:

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.

Source
describe_availability_options!(client, input)

Specs:

Same as describe_availability_options/2 but raise on error.

Source
describe_domains(client, input)

Specs:

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.

Source
describe_domains!(client, input)

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.

Source
describe_expressions(client, input)

Specs:

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.

Source
describe_expressions!(client, input)

Specs:

Same as describe_expressions/2 but raise on error.

Source
describe_index_fields(client, input)

Specs:

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.

Source
describe_index_fields!(client, input)

Specs:

Same as describe_index_fields/2 but raise on error.

Source
describe_scaling_parameters(client, input)

Specs:

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.

Source
describe_scaling_parameters!(client, input)

Specs:

Same as describe_scaling_parameters/2 but raise on error.

Source
describe_service_access_policies(client, input)

Specs:

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.

Source
describe_service_access_policies!(client, input)

Specs:

Same as describe_service_access_policies/2 but raise on error.

Source
describe_suggesters(client, input)

Specs:

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.

Source
describe_suggesters!(client, input)

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.

Source
index_documents(client, input)

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.

Source
index_documents!(client, input)

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.

Source
list_domain_names(client)

Specs:

  • list_domain_names(client :: ExAws.Cloudsearch.t) :: ExAws.Request.Query.response_t

ListDomainNames

Lists all search domains owned by an account.

Source
list_domain_names!(client)

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.

Source
update_availability_options(client, input)

Specs:

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.

Source
update_availability_options!(client, input)

Specs:

Same as update_availability_options/2 but raise on error.

Source
update_scaling_parameters(client, input)

Specs:

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.

Source
update_scaling_parameters!(client, input)

Specs:

Same as update_scaling_parameters/2 but raise on error.

Source
update_service_access_policies(client, input)

Specs:

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.

Source
update_service_access_policies!(client, input)

Specs:

Same as update_service_access_policies/2 but raise on error.

Source