Module Smaws_Client_CloudSearch

CloudSearch client library built on EIO.

Types

module Types : sig ... end

Builders

val make_option_status : ?pending_deletion:Types.boolean_ -> ?update_version:Types.u_int_value -> state:Types.option_state -> update_date:Types.update_timestamp -> creation_date:Types.update_timestamp -> unit -> Types.option_status
val make_access_policies_status : status:Types.option_status -> options:Types.policy_document -> unit -> Types.access_policies_status
val make_update_service_access_policies_response : access_policies:Types.access_policies_status -> unit -> Types.update_service_access_policies_response
val make_update_service_access_policies_request : access_policies:Types.policy_document -> domain_name:Types.domain_name -> unit -> Types.update_service_access_policies_request
val make_scaling_parameters : ?desired_partition_count:Types.u_int_value -> ?desired_replication_count:Types.u_int_value -> ?desired_instance_type:Types.partition_instance_type -> unit -> Types.scaling_parameters
val make_scaling_parameters_status : status:Types.option_status -> options:Types.scaling_parameters -> unit -> Types.scaling_parameters_status
val make_update_scaling_parameters_response : scaling_parameters:Types.scaling_parameters_status -> unit -> Types.update_scaling_parameters_response
val make_update_scaling_parameters_request : scaling_parameters:Types.scaling_parameters -> domain_name:Types.domain_name -> unit -> Types.update_scaling_parameters_request
val make_domain_endpoint_options : ?tls_security_policy:Types.tls_security_policy -> ?enforce_http_s:Types.boolean_ -> unit -> Types.domain_endpoint_options
val make_domain_endpoint_options_status : status:Types.option_status -> options:Types.domain_endpoint_options -> unit -> Types.domain_endpoint_options_status
val make_update_domain_endpoint_options_response : ?domain_endpoint_options:Types.domain_endpoint_options_status -> unit -> Types.update_domain_endpoint_options_response
val make_update_domain_endpoint_options_request : domain_endpoint_options:Types.domain_endpoint_options -> domain_name:Types.domain_name -> unit -> Types.update_domain_endpoint_options_request
val make_availability_options_status : status:Types.option_status -> options:Types.multi_a_z -> unit -> Types.availability_options_status
val make_update_availability_options_response : ?availability_options:Types.availability_options_status -> unit -> Types.update_availability_options_response
val make_update_availability_options_request : multi_a_z:Types.boolean_ -> domain_name:Types.domain_name -> unit -> Types.update_availability_options_request
val make_text_options : ?analysis_scheme:Types.word -> ?highlight_enabled:Types.boolean_ -> ?sort_enabled:Types.boolean_ -> ?return_enabled:Types.boolean_ -> ?source_field:Types.field_name -> ?default_value:Types.field_value -> unit -> Types.text_options
val make_text_array_options : ?analysis_scheme:Types.word -> ?highlight_enabled:Types.boolean_ -> ?return_enabled:Types.boolean_ -> ?source_fields:Types.field_name_comma_list -> ?default_value:Types.field_value -> unit -> Types.text_array_options
val make_document_suggester_options : ?sort_expression:Types.string_ -> ?fuzzy_matching:Types.suggester_fuzzy_matching -> source_field:Types.field_name -> unit -> Types.document_suggester_options
val make_suggester : document_suggester_options:Types.document_suggester_options -> suggester_name:Types.standard_name -> unit -> Types.suggester
val make_suggester_status : status:Types.option_status -> options:Types.suggester -> unit -> Types.suggester_status
val make_service_endpoint : ?endpoint:Types.service_url -> unit -> Types.service_endpoint
val make_literal_options : ?sort_enabled:Types.boolean_ -> ?return_enabled:Types.boolean_ -> ?search_enabled:Types.boolean_ -> ?facet_enabled:Types.boolean_ -> ?source_field:Types.field_name -> ?default_value:Types.field_value -> unit -> Types.literal_options
val make_literal_array_options : ?return_enabled:Types.boolean_ -> ?search_enabled:Types.boolean_ -> ?facet_enabled:Types.boolean_ -> ?source_fields:Types.field_name_comma_list -> ?default_value:Types.field_value -> unit -> Types.literal_array_options
val make_list_domain_names_response : ?domain_names:Types.domain_name_map -> unit -> Types.list_domain_names_response
val make_limits : maximum_partition_count:Types.maximum_partition_count -> maximum_replication_count:Types.maximum_replication_count -> unit -> Types.limits
val make_lat_lon_options : ?sort_enabled:Types.boolean_ -> ?return_enabled:Types.boolean_ -> ?search_enabled:Types.boolean_ -> ?facet_enabled:Types.boolean_ -> ?source_field:Types.field_name -> ?default_value:Types.field_value -> unit -> Types.lat_lon_options
val make_int_options : ?sort_enabled:Types.boolean_ -> ?return_enabled:Types.boolean_ -> ?search_enabled:Types.boolean_ -> ?facet_enabled:Types.boolean_ -> ?source_field:Types.field_name -> ?default_value:Types.long -> unit -> Types.int_options
val make_int_array_options : ?return_enabled:Types.boolean_ -> ?search_enabled:Types.boolean_ -> ?facet_enabled:Types.boolean_ -> ?source_fields:Types.field_name_comma_list -> ?default_value:Types.long -> unit -> Types.int_array_options
val make_double_options : ?sort_enabled:Types.boolean_ -> ?return_enabled:Types.boolean_ -> ?search_enabled:Types.boolean_ -> ?facet_enabled:Types.boolean_ -> ?source_field:Types.field_name -> ?default_value:Types.double -> unit -> Types.double_options
val make_date_options : ?sort_enabled:Types.boolean_ -> ?return_enabled:Types.boolean_ -> ?search_enabled:Types.boolean_ -> ?facet_enabled:Types.boolean_ -> ?source_field:Types.field_name -> ?default_value:Types.field_value -> unit -> Types.date_options
val make_double_array_options : ?return_enabled:Types.boolean_ -> ?search_enabled:Types.boolean_ -> ?facet_enabled:Types.boolean_ -> ?source_fields:Types.field_name_comma_list -> ?default_value:Types.double -> unit -> Types.double_array_options
val make_date_array_options : ?return_enabled:Types.boolean_ -> ?search_enabled:Types.boolean_ -> ?facet_enabled:Types.boolean_ -> ?source_fields:Types.field_name_comma_list -> ?default_value:Types.field_value -> unit -> Types.date_array_options
val make_index_field : ?date_array_options:Types.date_array_options -> ?text_array_options:Types.text_array_options -> ?literal_array_options:Types.literal_array_options -> ?double_array_options:Types.double_array_options -> ?int_array_options:Types.int_array_options -> ?lat_lon_options:Types.lat_lon_options -> ?date_options:Types.date_options -> ?text_options:Types.text_options -> ?literal_options:Types.literal_options -> ?double_options:Types.double_options -> ?int_options:Types.int_options -> index_field_type:Types.index_field_type -> index_field_name:Types.dynamic_field_name -> unit -> Types.index_field
val make_index_field_status : status:Types.option_status -> options:Types.index_field -> unit -> Types.index_field_status
val make_index_documents_response : ?field_names:Types.field_name_list -> unit -> Types.index_documents_response
val make_index_documents_request : domain_name:Types.domain_name -> unit -> Types.index_documents_request
val make_expression : expression_value:Types.expression_value -> expression_name:Types.standard_name -> unit -> Types.expression
val make_expression_status : status:Types.option_status -> options:Types.expression -> unit -> Types.expression_status
val make_domain_status : ?limits:Types.limits -> ?search_instance_count:Types.instance_count -> ?search_partition_count:Types.partition_count -> ?search_instance_type:Types.search_instance_type -> ?processing:Types.boolean_ -> ?search_service:Types.service_endpoint -> ?doc_service:Types.service_endpoint -> ?deleted:Types.boolean_ -> ?created:Types.boolean_ -> ?ar_n:Types.ar_n -> requires_index_documents:Types.boolean_ -> domain_name:Types.domain_name -> domain_id:Types.domain_id -> unit -> Types.domain_status
val make_describe_suggesters_response : suggesters:Types.suggester_status_list -> unit -> Types.describe_suggesters_response
val make_describe_suggesters_request : ?deployed:Types.boolean_ -> ?suggester_names:Types.standard_name_list -> domain_name:Types.domain_name -> unit -> Types.describe_suggesters_request
val make_describe_service_access_policies_response : access_policies:Types.access_policies_status -> unit -> Types.describe_service_access_policies_response
val make_describe_service_access_policies_request : ?deployed:Types.boolean_ -> domain_name:Types.domain_name -> unit -> Types.describe_service_access_policies_request
val make_describe_scaling_parameters_response : scaling_parameters:Types.scaling_parameters_status -> unit -> Types.describe_scaling_parameters_response
val make_describe_scaling_parameters_request : domain_name:Types.domain_name -> unit -> Types.describe_scaling_parameters_request
val make_describe_index_fields_response : index_fields:Types.index_field_status_list -> unit -> Types.describe_index_fields_response
val make_describe_index_fields_request : ?deployed:Types.boolean_ -> ?field_names:Types.dynamic_field_name_list -> domain_name:Types.domain_name -> unit -> Types.describe_index_fields_request
val make_describe_expressions_response : expressions:Types.expression_status_list -> unit -> Types.describe_expressions_response
val make_describe_expressions_request : ?deployed:Types.boolean_ -> ?expression_names:Types.standard_name_list -> domain_name:Types.domain_name -> unit -> Types.describe_expressions_request
val make_describe_domains_response : domain_status_list:Types.domain_status_list -> unit -> Types.describe_domains_response
val make_describe_domains_request : ?domain_names:Types.domain_name_list -> unit -> Types.describe_domains_request
val make_describe_domain_endpoint_options_response : ?domain_endpoint_options:Types.domain_endpoint_options_status -> unit -> Types.describe_domain_endpoint_options_response
val make_describe_domain_endpoint_options_request : ?deployed:Types.boolean_ -> domain_name:Types.domain_name -> unit -> Types.describe_domain_endpoint_options_request
val make_describe_availability_options_response : ?availability_options:Types.availability_options_status -> unit -> Types.describe_availability_options_response
val make_describe_availability_options_request : ?deployed:Types.boolean_ -> domain_name:Types.domain_name -> unit -> Types.describe_availability_options_request
val make_analysis_options : ?algorithmic_stemming:Types.algorithmic_stemming -> ?japanese_tokenization_dictionary:Types.string_ -> ?stemming_dictionary:Types.string_ -> ?stopwords:Types.string_ -> ?synonyms:Types.string_ -> unit -> Types.analysis_options
val make_analysis_scheme : ?analysis_options:Types.analysis_options -> analysis_scheme_language:Types.analysis_scheme_language -> analysis_scheme_name:Types.standard_name -> unit -> Types.analysis_scheme
val make_analysis_scheme_status : status:Types.option_status -> options:Types.analysis_scheme -> unit -> Types.analysis_scheme_status
val make_describe_analysis_schemes_response : analysis_schemes:Types.analysis_scheme_status_list -> unit -> Types.describe_analysis_schemes_response
val make_describe_analysis_schemes_request : ?deployed:Types.boolean_ -> ?analysis_scheme_names:Types.standard_name_list -> domain_name:Types.domain_name -> unit -> Types.describe_analysis_schemes_request
val make_delete_suggester_response : suggester:Types.suggester_status -> unit -> Types.delete_suggester_response
val make_delete_suggester_request : suggester_name:Types.standard_name -> domain_name:Types.domain_name -> unit -> Types.delete_suggester_request
val make_delete_index_field_response : index_field:Types.index_field_status -> unit -> Types.delete_index_field_response
val make_delete_index_field_request : index_field_name:Types.dynamic_field_name -> domain_name:Types.domain_name -> unit -> Types.delete_index_field_request
val make_delete_expression_response : expression:Types.expression_status -> unit -> Types.delete_expression_response
val make_delete_expression_request : expression_name:Types.standard_name -> domain_name:Types.domain_name -> unit -> Types.delete_expression_request
val make_delete_domain_response : ?domain_status:Types.domain_status -> unit -> Types.delete_domain_response
val make_delete_domain_request : domain_name:Types.domain_name -> unit -> Types.delete_domain_request
val make_delete_analysis_scheme_response : analysis_scheme:Types.analysis_scheme_status -> unit -> Types.delete_analysis_scheme_response
val make_delete_analysis_scheme_request : analysis_scheme_name:Types.standard_name -> domain_name:Types.domain_name -> unit -> Types.delete_analysis_scheme_request
val make_define_suggester_response : suggester:Types.suggester_status -> unit -> Types.define_suggester_response
val make_define_suggester_request : suggester:Types.suggester -> domain_name:Types.domain_name -> unit -> Types.define_suggester_request
val make_define_index_field_response : index_field:Types.index_field_status -> unit -> Types.define_index_field_response
val make_define_index_field_request : index_field:Types.index_field -> domain_name:Types.domain_name -> unit -> Types.define_index_field_request
val make_define_expression_response : expression:Types.expression_status -> unit -> Types.define_expression_response
val make_define_expression_request : expression:Types.expression -> domain_name:Types.domain_name -> unit -> Types.define_expression_request
val make_define_analysis_scheme_response : analysis_scheme:Types.analysis_scheme_status -> unit -> Types.define_analysis_scheme_response
val make_define_analysis_scheme_request : analysis_scheme:Types.analysis_scheme -> domain_name:Types.domain_name -> unit -> Types.define_analysis_scheme_request
val make_create_domain_response : ?domain_status:Types.domain_status -> unit -> Types.create_domain_response
val make_create_domain_request : domain_name:Types.domain_name -> unit -> Types.create_domain_request
val make_build_suggesters_response : ?field_names:Types.field_name_list -> unit -> Types.build_suggesters_response
val make_build_suggesters_request : domain_name:Types.domain_name -> unit -> Types.build_suggesters_request

Operations

module BuildSuggesters : sig ... end

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

module CreateDomain : sig ... end

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

module DefineAnalysisScheme : sig ... end

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.

module DefineExpression : sig ... end

Configures an

module DefineIndexField : sig ... end

Configures an

module DefineSuggester : sig ... end

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.

module DeleteAnalysisScheme : sig ... end

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

module DeleteDomain : sig ... end

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.

module DeleteExpression : sig ... end

Removes an

module DeleteIndexField : sig ... end

Removes an

module DeleteSuggester : sig ... end

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

module DescribeAnalysisSchemes : sig ... end

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.

module DescribeAvailabilityOptions : sig ... end

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.

module DescribeDomainEndpointOptions : sig ... end

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.

module DescribeDomains : sig ... end

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.

module DescribeExpressions : sig ... end

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.

module DescribeIndexFields : sig ... end

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.

module DescribeScalingParameters : sig ... end

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.

module DescribeServiceAccessPolicies : sig ... end

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.

module DescribeSuggesters : sig ... end

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.

module IndexDocuments : sig ... end

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.

module ListDomainNames : sig ... end

Lists all search domains owned by an account.

module UpdateAvailabilityOptions : sig ... end

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.

module UpdateDomainEndpointOptions : sig ... end

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.

module UpdateScalingParameters : sig ... end

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.

module UpdateServiceAccessPolicies : sig ... end
module Query_serializers : sig ... end
module Query_deserializers : sig ... end