AWS.CloudSearch (aws-elixir v0.8.0) View Source

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.

Link to this section Summary

Functions

Indexes the search suggestions.

Creates a new search domain.

Configures an analysis scheme that can be applied to a text or text-array field to define language-specific text processing options.

Configures an Expression for the search domain.

Configures an IndexField for the search domain.

Configures a suggester for a domain.

Permanently deletes a search domain and all of its data.

Removes an Expression from the search domain.

Removes an IndexField from the search domain.

Gets the analysis schemes configured for a domain.

Gets the availability options configured for a domain.

Returns the domain's endpoint options, specifically whether all requests to the domain must arrive over HTTPS.

Gets information about the search domains owned by this account.

Gets the expressions configured for the search domain.

Gets information about the index fields configured for the search domain.

Gets the scaling parameters configured for a domain.

Gets information about the access policies that control access to the domain's document and search endpoints.

Gets the suggesters configured for a domain.

Tells the search domain to start indexing its documents using the latest indexing options.

Lists all search domains owned by an account.

Configures the availability options for a domain.

Updates the domain's endpoint options, specifically whether all requests to the domain must arrive over HTTPS.

Configures scaling parameters for a domain.

Configures the access rules that control access to the domain's document and search endpoints.

Link to this section Functions

Link to this function

build_suggesters(client, input, options \\ [])

View Source

Indexes the search suggestions.

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

Link to this function

create_domain(client, input, options \\ [])

View Source

Creates a new search domain.

For more information, see Creating a Search Domain in the Amazon CloudSearch Developer Guide.

Link to this function

define_analysis_scheme(client, input, options \\ [])

View Source

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.

Link to this function

define_expression(client, input, options \\ [])

View Source

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.

Link to this function

define_index_field(client, input, options \\ [])

View Source

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.

Link to this function

define_suggester(client, input, options \\ [])

View Source

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.

Link to this function

delete_analysis_scheme(client, input, options \\ [])

View Source

Deletes an analysis scheme.

For more information, see Configuring Analysis Schemes in the Amazon CloudSearch Developer Guide.

Link to this function

delete_domain(client, input, options \\ [])

View Source

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.

Link to this function

delete_expression(client, input, options \\ [])

View Source

Removes an Expression from the search domain.

For more information, see Configuring Expressions in the Amazon CloudSearch Developer Guide.

Link to this function

delete_index_field(client, input, options \\ [])

View Source

Removes an IndexField from the search domain.

For more information, see Configuring Index Fields in the Amazon CloudSearch Developer Guide.

Link to this function

delete_suggester(client, input, options \\ [])

View Source

Deletes a suggester.

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

Link to this function

describe_analysis_schemes(client, input, options \\ [])

View Source

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.

Link to this function

describe_availability_options(client, input, options \\ [])

View Source

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.

Link to this function

describe_domain_endpoint_options(client, input, options \\ [])

View Source

Returns the domain's endpoint options, specifically whether all requests to the domain must arrive over HTTPS.

For more information, see Configuring Domain Endpoint Options in the Amazon CloudSearch Developer Guide.

Link to this function

describe_domains(client, input, options \\ [])

View Source

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.

Link to this function

describe_expressions(client, input, options \\ [])

View Source

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.

Link to this function

describe_index_fields(client, input, options \\ [])

View Source

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.

Link to this function

describe_scaling_parameters(client, input, options \\ [])

View Source

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.

Link to this function

describe_service_access_policies(client, input, options \\ [])

View Source

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.

Link to this function

describe_suggesters(client, input, options \\ [])

View Source

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.

Link to this function

index_documents(client, input, options \\ [])

View Source

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.

Link to this function

list_domain_names(client, input, options \\ [])

View Source

Lists all search domains owned by an account.

Link to this function

update_availability_options(client, input, options \\ [])

View Source

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.

Link to this function

update_domain_endpoint_options(client, input, options \\ [])

View Source

Updates the domain's endpoint options, specifically whether all requests to the domain must arrive over HTTPS.

For more information, see Configuring Domain Endpoint Options in the Amazon CloudSearch Developer Guide.

Link to this function

update_scaling_parameters(client, input, options \\ [])

View Source

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.

Link to this function

update_service_access_policies(client, input, options \\ [])

View Source

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.