Module Smaws_Client_CloudSearch.Types

type nonrec word = string
type nonrec error_code = string
type nonrec error_message = string
type nonrec validation_exception = {
  1. message : error_message option;
  2. code : error_code option;
}

The request was rejected because it has invalid parameters.

type nonrec update_timestamp = Smaws_Lib.CoreTypes.Timestamp.t
type nonrec policy_document = string
type nonrec u_int_value = int
type nonrec option_state =
  1. | FailedToValidate
  2. | Active
  3. | Processing
  4. | RequiresIndexDocuments

The state of processing a change to an option. One of:

  • RequiresIndexDocuments: The option's latest value will not be deployed until IndexDocuments has been called and indexing is complete.
  • Processing: The option's latest value is in the process of being activated.
  • Active: The option's latest value is fully deployed.
  • FailedToValidate: The option value is not compatible with the domain's data and cannot be used to index the data. You must either modify the option value or update or remove the incompatible documents.
type nonrec boolean_ = bool
type nonrec option_status = {
  1. pending_deletion : boolean_ option;
    (*

    Indicates that the option will be deleted once processing is complete.

    *)
  2. state : option_state;
    (*

    The state of processing a change to an option. Possible values:

    • RequiresIndexDocuments: the option's latest value will not be deployed until IndexDocuments has been called and indexing is complete.
    • Processing: the option's latest value is in the process of being activated.
    • Active: the option's latest value is completely deployed.
    • FailedToValidate: the option value is not compatible with the domain's data and cannot be used to index the data. You must either modify the option value or update or remove the incompatible documents.
    *)
  3. update_version : u_int_value option;
    (*

    A unique integer that indicates when this option was last updated.

    *)
  4. update_date : update_timestamp;
    (*

    A timestamp for when this option was last updated.

    *)
  5. creation_date : update_timestamp;
    (*

    A timestamp for when this option was created.

    *)
}

The status of domain configuration option.

type nonrec access_policies_status = {
  1. status : option_status;
  2. options : policy_document;
}

The configured access rules for the domain's document and search endpoints, and the current status of those rules.

type nonrec update_service_access_policies_response = {
  1. access_policies : access_policies_status;
    (*

    The access rules configured for the domain.

    *)
}

The result of an UpdateServiceAccessPolicies request. Contains the new access policies.

type nonrec domain_name = string
type nonrec update_service_access_policies_request = {
  1. access_policies : policy_document;
    (*

    The access rules you want to configure. These rules replace any existing rules.

    *)
  2. domain_name : domain_name;
}

Container for the parameters to the

[UpdateServiceAccessPolicies]

operation. Specifies the name of the domain you want to update and the access rules you want to configure.

type nonrec resource_not_found_exception = {
  1. message : error_message option;
  2. code : error_code option;
}

The request was rejected because it attempted to reference a resource that does not exist.

type nonrec limit_exceeded_exception = {
  1. message : error_message option;
  2. code : error_code option;
}

The request was rejected because a resource limit has already been met.

type nonrec invalid_type_exception = {
  1. message : error_message option;
  2. code : error_code option;
}

The request was rejected because it specified an invalid type definition.

type nonrec internal_exception = {
  1. message : error_message option;
  2. code : error_code option;
}

An internal error occurred while processing the request. If this problem persists, report an issue from the Service Health Dashboard.

type nonrec base_exception = {
  1. message : error_message option;
  2. code : error_code option;
}

An error occurred while processing the request.

type nonrec partition_instance_type =
  1. | Search_previousgeneration_2xlarge
  2. | Search_previousgeneration_xlarge
  3. | Search_previousgeneration_large
  4. | Search_previousgeneration_small
  5. | Search_2xlarge
  6. | Search_xlarge
  7. | Search_large
  8. | Search_medium
  9. | Search_small
  10. | Search_m3_2xlarge
  11. | Search_m3_xlarge
  12. | Search_m3_large
  13. | Search_m3_medium
  14. | Search_m2_2xlarge
  15. | Search_m2_xlarge
  16. | Search_m1_large
  17. | Search_m1_small

The instance type (such as search.m1.small) on which an index partition is hosted.

type nonrec scaling_parameters = {
  1. desired_partition_count : u_int_value option;
    (*

    The number of partitions you want to preconfigure for your domain. Only valid when you select m2.2xlarge as the desired instance type.

    *)
  2. desired_replication_count : u_int_value option;
    (*

    The number of replicas you want to preconfigure for each index partition.

    *)
  3. desired_instance_type : partition_instance_type option;
    (*

    The instance type that you want to preconfigure for your domain. For example, search.m1.small.

    *)
}

The desired instance type and desired number of replicas of each index partition.

type nonrec scaling_parameters_status = {
  1. status : option_status;
  2. options : scaling_parameters;
}

The status and configuration of a search domain's scaling parameters.

type nonrec update_scaling_parameters_response = {
  1. scaling_parameters : scaling_parameters_status;
}

The result of a UpdateScalingParameters request. Contains the status of the newly-configured scaling parameters.

type nonrec update_scaling_parameters_request = {
  1. scaling_parameters : scaling_parameters;
  2. domain_name : domain_name;
}

Container for the parameters to the

[UpdateScalingParameters]

operation. Specifies the name of the domain you want to update and the scaling parameters you want to configure.

type nonrec tls_security_policy =
  1. | POLICY_MIN_TLS_1_2_2019_07
  2. | POLICY_MIN_TLS_1_0_2019_07

The minimum required TLS version.

type nonrec domain_endpoint_options = {
  1. tls_security_policy : tls_security_policy option;
    (*

    The minimum required TLS version

    *)
  2. enforce_http_s : boolean_ option;
    (*

    Whether the domain is HTTPS only enabled.

    *)
}

The domain's endpoint options.

type nonrec domain_endpoint_options_status = {
  1. status : option_status;
    (*

    The status of the configured domain endpoint options.

    *)
  2. options : domain_endpoint_options;
    (*

    The domain endpoint options configured for the domain.

    *)
}

The configuration and status of the domain's endpoint options.

type nonrec update_domain_endpoint_options_response = {
  1. domain_endpoint_options : domain_endpoint_options_status option;
    (*

    The newly-configured domain endpoint options.

    *)
}

The result of a UpdateDomainEndpointOptions request. Contains the configuration and status of the domain's endpoint options.

type nonrec update_domain_endpoint_options_request = {
  1. domain_endpoint_options : domain_endpoint_options;
    (*

    Whether to require that all requests to the domain arrive over HTTPS. We recommend Policy-Min-TLS-1-2-2019-07 for TLSSecurityPolicy. For compatibility with older clients, the default is Policy-Min-TLS-1-0-2019-07.

    *)
  2. domain_name : domain_name;
    (*

    A string that represents the name of a domain.

    *)
}

Container for the parameters to the

[UpdateDomainEndpointOptions]

operation. Specifies the name of the domain you want to update and the domain endpoint options.

type nonrec disabled_operation_exception = {
  1. message : error_message option;
  2. code : error_code option;
}

The request was rejected because it attempted an operation which is not enabled.

type nonrec multi_a_z = bool
type nonrec availability_options_status = {
  1. status : option_status;
  2. options : multi_a_z;
    (*

    The availability options configured for the domain.

    *)
}

The status and configuration of the domain's availability options.

type nonrec update_availability_options_response = {
  1. availability_options : availability_options_status option;
    (*

    The newly-configured availability options. Indicates whether Multi-AZ is enabled for the domain.

    *)
}

The result of a UpdateAvailabilityOptions request. Contains the status of the domain's availability options.

type nonrec update_availability_options_request = {
  1. multi_a_z : boolean_;
    (*

    You expand an existing search domain to a second Availability Zone by setting the Multi-AZ option to true. Similarly, you can turn off the Multi-AZ option to downgrade the domain to a single Availability Zone by setting the Multi-AZ option to false.

    *)
  2. domain_name : domain_name;
}

Container for the parameters to the

[UpdateAvailabilityOptions]

operation. Specifies the name of the domain you want to update and the Multi-AZ availability option.

type nonrec field_value = string
type nonrec field_name = string
type nonrec text_options = {
  1. analysis_scheme : word option;
    (*

    The name of an analysis scheme for a text field.

    *)
  2. highlight_enabled : boolean_ option;
    (*

    Whether highlights can be returned for the field.

    *)
  3. sort_enabled : boolean_ option;
    (*

    Whether the field can be used to sort the search results.

    *)
  4. return_enabled : boolean_ option;
    (*

    Whether the contents of the field can be returned in the search results.

    *)
  5. source_field : field_name option;
  6. default_value : field_value option;
    (*

    A value to use for the field if the field isn't specified for a document.

    *)
}

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.

type nonrec field_name_comma_list = string
type nonrec text_array_options = {
  1. analysis_scheme : word option;
    (*

    The name of an analysis scheme for a text-array field.

    *)
  2. highlight_enabled : boolean_ option;
    (*

    Whether highlights can be returned for the field.

    *)
  3. return_enabled : boolean_ option;
    (*

    Whether the contents of the field can be returned in the search results.

    *)
  4. source_fields : field_name_comma_list option;
    (*

    A list of source fields to map to the field.

    *)
  5. default_value : field_value option;
    (*

    A value to use for the field if the field isn't specified for a document.

    *)
}

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.

type nonrec standard_name = string
type nonrec suggester_fuzzy_matching =
  1. | High
  2. | Low
  3. | None_
type nonrec string_ = string
type nonrec document_suggester_options = {
  1. sort_expression : string_ option;
    (*

    An expression that computes a score for each suggestion to control how they are sorted. The scores are rounded to the nearest integer, with a floor of 0 and a ceiling of 2^31-1. A document's relevance score is not computed for suggestions, so sort expressions cannot reference the _score value. To sort suggestions using a numeric field or existing expression, simply specify the name of the field or expression. If no expression is configured for the suggester, the suggestions are sorted with the closest matches listed first.

    *)
  2. fuzzy_matching : suggester_fuzzy_matching option;
    (*

    The level of fuzziness allowed when suggesting matches for a string: none, low, or high. With none, the specified string is treated as an exact prefix. With low, suggestions must differ from the specified string by no more than one character. With high, suggestions can differ by up to two characters. The default is none.

    *)
  3. source_field : field_name;
    (*

    The name of the index field you want to use for suggestions.

    *)
}

Options for a search suggester.

type nonrec suggester = {
  1. document_suggester_options : document_suggester_options;
  2. suggester_name : standard_name;
}

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.

type nonrec suggester_status = {
  1. status : option_status;
  2. options : suggester;
}

The value of a Suggester and its current status.

type nonrec suggester_status_list = suggester_status list
type nonrec standard_name_list = standard_name list
type nonrec service_url = string
type nonrec service_endpoint = {
  1. endpoint : service_url option;
}

The endpoint to which service requests can be submitted.

type nonrec search_instance_type = string
type nonrec resource_already_exists_exception = {
  1. message : error_message option;
  2. code : error_code option;
}

The request was rejected because it attempted to create a resource that already exists.

type nonrec partition_count = int
type nonrec maximum_replication_count = int
type nonrec maximum_partition_count = int
type nonrec long = Smaws_Lib.CoreTypes.Int64.t
type nonrec literal_options = {
  1. sort_enabled : boolean_ option;
    (*

    Whether the field can be used to sort the search results.

    *)
  2. return_enabled : boolean_ option;
    (*

    Whether the contents of the field can be returned in the search results.

    *)
  3. search_enabled : boolean_ option;
    (*

    Whether the contents of the field are searchable.

    *)
  4. facet_enabled : boolean_ option;
    (*

    Whether facet information can be returned for the field.

    *)
  5. source_field : field_name option;
  6. default_value : field_value option;
    (*

    A value to use for the field if the field isn't specified for a document.

    *)
}

Options for literal field. Present if IndexFieldType specifies the field is of type literal. All options are enabled by default.

type nonrec literal_array_options = {
  1. return_enabled : boolean_ option;
    (*

    Whether the contents of the field can be returned in the search results.

    *)
  2. search_enabled : boolean_ option;
    (*

    Whether the contents of the field are searchable.

    *)
  3. facet_enabled : boolean_ option;
    (*

    Whether facet information can be returned for the field.

    *)
  4. source_fields : field_name_comma_list option;
    (*

    A list of source fields to map to the field.

    *)
  5. default_value : field_value option;
    (*

    A value to use for the field if the field isn't specified for a document.

    *)
}

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.

type nonrec api_version = string
type nonrec domain_name_map = (domain_name * api_version) list

A collection of domain names.

type nonrec list_domain_names_response = {
  1. domain_names : domain_name_map option;
    (*

    The names of the search domains owned by an account.

    *)
}

The result of a ListDomainNames request. Contains a list of the domains owned by an account.

type nonrec limits = {
  1. maximum_partition_count : maximum_partition_count;
  2. maximum_replication_count : maximum_replication_count;
}
type nonrec lat_lon_options = {
  1. sort_enabled : boolean_ option;
    (*

    Whether the field can be used to sort the search results.

    *)
  2. return_enabled : boolean_ option;
    (*

    Whether the contents of the field can be returned in the search results.

    *)
  3. search_enabled : boolean_ option;
    (*

    Whether the contents of the field are searchable.

    *)
  4. facet_enabled : boolean_ option;
    (*

    Whether facet information can be returned for the field.

    *)
  5. source_field : field_name option;
  6. default_value : field_value option;
    (*

    A value to use for the field if the field isn't specified for a document.

    *)
}

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.

type nonrec int_options = {
  1. sort_enabled : boolean_ option;
    (*

    Whether the field can be used to sort the search results.

    *)
  2. return_enabled : boolean_ option;
    (*

    Whether the contents of the field can be returned in the search results.

    *)
  3. search_enabled : boolean_ option;
    (*

    Whether the contents of the field are searchable.

    *)
  4. facet_enabled : boolean_ option;
    (*

    Whether facet information can be returned for the field.

    *)
  5. source_field : field_name option;
    (*

    The name of the source field to map to the field.

    *)
  6. default_value : long option;
    (*

    A value to use for the field if the field isn't specified for a document. This can be important if you are using the field in an expression and that field is not present in every document.

    *)
}

Options for a 64-bit signed integer field. Present if IndexFieldType specifies the field is of type int. All options are enabled by default.

type nonrec int_array_options = {
  1. return_enabled : boolean_ option;
    (*

    Whether the contents of the field can be returned in the search results.

    *)
  2. search_enabled : boolean_ option;
    (*

    Whether the contents of the field are searchable.

    *)
  3. facet_enabled : boolean_ option;
    (*

    Whether facet information can be returned for the field.

    *)
  4. source_fields : field_name_comma_list option;
    (*

    A list of source fields to map to the field.

    *)
  5. default_value : long option;
    (*

    A value to use for the field if the field isn't specified for a document.

    *)
}

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.

type nonrec instance_count = int
type nonrec index_field_type =
  1. | Date_array
  2. | Text_array
  3. | Literal_array
  4. | Double_array
  5. | Int_array
  6. | Latlon
  7. | Date
  8. | Text
  9. | Literal
  10. | Double
  11. | Int

The type of field. The valid options for a field depend on the field type. For more information about the supported field types, see Configuring Index Fields in the Amazon CloudSearch Developer Guide.

type nonrec dynamic_field_name = string
type nonrec double = float
type nonrec double_options = {
  1. sort_enabled : boolean_ option;
    (*

    Whether the field can be used to sort the search results.

    *)
  2. return_enabled : boolean_ option;
    (*

    Whether the contents of the field can be returned in the search results.

    *)
  3. search_enabled : boolean_ option;
    (*

    Whether the contents of the field are searchable.

    *)
  4. facet_enabled : boolean_ option;
    (*

    Whether facet information can be returned for the field.

    *)
  5. source_field : field_name option;
    (*

    The name of the source field to map to the field.

    *)
  6. default_value : double option;
    (*

    A value to use for the field if the field isn't specified for a document. This can be important if you are using the field in an expression and that field is not present in every document.

    *)
}

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.

type nonrec date_options = {
  1. sort_enabled : boolean_ option;
    (*

    Whether the field can be used to sort the search results.

    *)
  2. return_enabled : boolean_ option;
    (*

    Whether the contents of the field can be returned in the search results.

    *)
  3. search_enabled : boolean_ option;
    (*

    Whether the contents of the field are searchable.

    *)
  4. facet_enabled : boolean_ option;
    (*

    Whether facet information can be returned for the field.

    *)
  5. source_field : field_name option;
  6. default_value : field_value option;
    (*

    A value to use for the field if the field isn't specified for a document.

    *)
}

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.

type nonrec double_array_options = {
  1. return_enabled : boolean_ option;
    (*

    Whether the contents of the field can be returned in the search results.

    *)
  2. search_enabled : boolean_ option;
    (*

    Whether the contents of the field are searchable.

    *)
  3. facet_enabled : boolean_ option;
    (*

    Whether facet information can be returned for the field.

    *)
  4. source_fields : field_name_comma_list option;
    (*

    A list of source fields to map to the field.

    *)
  5. default_value : double option;
    (*

    A value to use for the field if the field isn't specified for a document.

    *)
}

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.

type nonrec date_array_options = {
  1. return_enabled : boolean_ option;
    (*

    Whether the contents of the field can be returned in the search results.

    *)
  2. search_enabled : boolean_ option;
    (*

    Whether the contents of the field are searchable.

    *)
  3. facet_enabled : boolean_ option;
    (*

    Whether facet information can be returned for the field.

    *)
  4. source_fields : field_name_comma_list option;
    (*

    A list of source fields to map to the field.

    *)
  5. default_value : field_value option;
    (*

    A value to use for the field if the field isn't specified for a document.

    *)
}

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.

type nonrec index_field = {
  1. date_array_options : date_array_options option;
  2. text_array_options : text_array_options option;
  3. literal_array_options : literal_array_options option;
  4. double_array_options : double_array_options option;
  5. int_array_options : int_array_options option;
  6. lat_lon_options : lat_lon_options option;
  7. date_options : date_options option;
  8. text_options : text_options option;
  9. literal_options : literal_options option;
  10. double_options : double_options option;
  11. int_options : int_options option;
  12. index_field_type : index_field_type;
  13. index_field_name : dynamic_field_name;
    (*

    A string that represents the name of an index field. CloudSearch supports regular index fields as well as dynamic fields. A dynamic field's name defines a pattern that begins or ends with a wildcard. Any document fields that don't map to a regular index field but do match a dynamic field's pattern are configured with the dynamic field's indexing options.

    Regular field names begin with a letter and can contain the following characters: a-z (lowercase), 0-9, and _ (underscore). Dynamic field names must begin or end with a wildcard (*). The wildcard can also be the only character in a dynamic field name. Multiple wildcards, and wildcards embedded within a string are not supported.

    The name score is reserved and cannot be used as a field name. To reference a document's ID, you can use the name _id.

    *)
}

Configuration information for a field in the index, including its name, type, and options. The supported options depend on the

[IndexFieldType]

.

type nonrec index_field_status = {
  1. status : option_status;
  2. options : index_field;
}

The value of an IndexField and its current status.

type nonrec index_field_status_list = index_field_status list
type nonrec field_name_list = field_name list
type nonrec index_documents_response = {
  1. field_names : field_name_list option;
    (*

    The names of the fields that are currently being indexed.

    *)
}

The result of an IndexDocuments request. Contains the status of the indexing operation, including the fields being indexed.

type nonrec index_documents_request = {
  1. domain_name : domain_name;
}

Container for the parameters to the

[IndexDocuments]

operation. Specifies the name of the domain you want to re-index.

type nonrec expression_value = string
type nonrec expression = {
  1. expression_value : expression_value;
  2. expression_name : standard_name;
}

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.

type nonrec expression_status = {
  1. status : option_status;
  2. options : expression;
    (*

    The expression that is evaluated for sorting while processing a search request.

    *)
}

The value of an Expression and its current status.

type nonrec expression_status_list = expression_status list
type nonrec dynamic_field_name_list = dynamic_field_name list
type nonrec domain_id = string
type nonrec ar_n = string
type nonrec domain_status = {
  1. limits : limits option;
  2. search_instance_count : instance_count option;
    (*

    The number of search instances that are available to process search requests.

    *)
  3. search_partition_count : partition_count option;
    (*

    The number of partitions across which the search index is spread.

    *)
  4. search_instance_type : search_instance_type option;
    (*

    The instance type that is being used to process search requests.

    *)
  5. processing : boolean_ option;
    (*

    True if processing is being done to activate the current domain configuration.

    *)
  6. requires_index_documents : boolean_;
    (*

    True if IndexDocuments needs to be called to activate the current domain configuration.

    *)
  7. search_service : service_endpoint option;
    (*

    The service endpoint for requesting search results from a search domain.

    *)
  8. doc_service : service_endpoint option;
    (*

    The service endpoint for updating documents in a search domain.

    *)
  9. deleted : boolean_ option;
    (*

    True if the search domain has been deleted. The system must clean up resources dedicated to the search domain when DeleteDomain is called. Newly deleted search domains are returned from DescribeDomains with a true value for IsDeleted for several minutes until resource cleanup is complete.

    *)
  10. created : boolean_ option;
    (*

    True if the search domain is created. It can take several minutes to initialize a domain when CreateDomain is called. Newly created search domains are returned from DescribeDomains with a false value for Created until domain creation is complete.

    *)
  11. ar_n : ar_n option;
  12. domain_name : domain_name;
  13. domain_id : domain_id;
}

The current status of the search domain.

type nonrec domain_status_list = domain_status list
type nonrec domain_name_list = domain_name list
type nonrec describe_suggesters_response = {
  1. suggesters : suggester_status_list;
    (*

    The suggesters configured for the domain specified in the request.

    *)
}

The result of a DescribeSuggesters request.

type nonrec describe_suggesters_request = {
  1. deployed : boolean_ option;
    (*

    Whether to display the deployed configuration (true) or include any pending changes (false). Defaults to false.

    *)
  2. suggester_names : standard_name_list option;
    (*

    The suggesters you want to describe.

    *)
  3. domain_name : domain_name;
    (*

    The name of the domain you want to describe.

    *)
}

Container for the parameters to the

[DescribeSuggester]

operation. Specifies the name of the domain you want to describe. To restrict the response to particular suggesters, specify the names of the suggesters you want to describe. To show the active configuration and exclude any pending changes, set the Deployed option to true.

type nonrec describe_service_access_policies_response = {
  1. access_policies : access_policies_status;
    (*

    The access rules configured for the domain specified in the request.

    *)
}

The result of a DescribeServiceAccessPolicies request.

type nonrec describe_service_access_policies_request = {
  1. deployed : boolean_ option;
    (*

    Whether to display the deployed configuration (true) or include any pending changes (false). Defaults to false.

    *)
  2. domain_name : domain_name;
    (*

    The name of the domain you want to describe.

    *)
}

Container for the parameters to the

[DescribeServiceAccessPolicies]

operation. Specifies the name of the domain you want to describe. To show the active configuration and exclude any pending changes, set the Deployed option to true.

type nonrec describe_scaling_parameters_response = {
  1. scaling_parameters : scaling_parameters_status;
}

The result of a DescribeScalingParameters request. Contains the scaling parameters configured for the domain specified in the request.

type nonrec describe_scaling_parameters_request = {
  1. domain_name : domain_name;
}

Container for the parameters to the

[DescribeScalingParameters]

operation. Specifies the name of the domain you want to describe.

type nonrec describe_index_fields_response = {
  1. index_fields : index_field_status_list;
    (*

    The index fields configured for the domain.

    *)
}

The result of a DescribeIndexFields request. Contains the index fields configured for the domain specified in the request.

type nonrec describe_index_fields_request = {
  1. deployed : boolean_ option;
    (*

    Whether to display the deployed configuration (true) or include any pending changes (false). Defaults to false.

    *)
  2. field_names : dynamic_field_name_list option;
    (*

    A list of the index fields you want to describe. If not specified, information is returned for all configured index fields.

    *)
  3. domain_name : domain_name;
    (*

    The name of the domain you want to describe.

    *)
}

Container for the parameters to the

[DescribeIndexFields]

operation. Specifies the name of the domain you want to describe. To restrict the response to particular index fields, specify the names of the index fields you want to describe. To show the active configuration and exclude any pending changes, set the Deployed option to true.

type nonrec describe_expressions_response = {
  1. expressions : expression_status_list;
    (*

    The expressions configured for the domain.

    *)
}

The result of a DescribeExpressions request. Contains the expressions configured for the domain specified in the request.

type nonrec describe_expressions_request = {
  1. deployed : boolean_ option;
    (*

    Whether to display the deployed configuration (true) or include any pending changes (false). Defaults to false.

    *)
  2. expression_names : standard_name_list option;
    (*

    Limits the

    [DescribeExpressions]

    response to the specified expressions. If not specified, all expressions are shown.

    *)
  3. domain_name : domain_name;
    (*

    The name of the domain you want to describe.

    *)
}

Container for the parameters to the

[DescribeDomains]

operation. Specifies the name of the domain you want to describe. To restrict the response to particular expressions, specify the names of the expressions you want to describe. To show the active configuration and exclude any pending changes, set the Deployed option to true.

type nonrec describe_domains_response = {
  1. domain_status_list : domain_status_list;
}

The result of a DescribeDomains request. Contains the status of the domains specified in the request or all domains owned by the account.

type nonrec describe_domains_request = {
  1. domain_names : domain_name_list option;
    (*

    The names of the domains you want to include in the response.

    *)
}

Container for the parameters to the

[DescribeDomains]

operation. By default shows the status of all domains. To restrict the response to particular domains, specify the names of the domains you want to describe.

type nonrec describe_domain_endpoint_options_response = {
  1. domain_endpoint_options : domain_endpoint_options_status option;
    (*

    The status and configuration of a search domain's endpoint options.

    *)
}

The result of a DescribeDomainEndpointOptions request. Contains the status and configuration of a search domain's endpoint options.

type nonrec describe_domain_endpoint_options_request = {
  1. deployed : boolean_ option;
    (*

    Whether to retrieve the latest configuration (which might be in a Processing state) or the current, active configuration. Defaults to false.

    *)
  2. domain_name : domain_name;
    (*

    A string that represents the name of a domain.

    *)
}

Container for the parameters to the

[DescribeDomainEndpointOptions]

operation. Specify the name of the domain you want to describe. To show the active configuration and exclude any pending changes, set the Deployed option to true.

type nonrec describe_availability_options_response = {
  1. availability_options : availability_options_status option;
    (*

    The availability options configured for the domain. Indicates whether Multi-AZ is enabled for the domain.

    *)
}

The result of a DescribeAvailabilityOptions request. Indicates whether or not the Multi-AZ option is enabled for the domain specified in the request.

type nonrec describe_availability_options_request = {
  1. deployed : boolean_ option;
    (*

    Whether to display the deployed configuration (true) or include any pending changes (false). Defaults to false.

    *)
  2. domain_name : domain_name;
    (*

    The name of the domain you want to describe.

    *)
}

Container for the parameters to the

[DescribeAvailabilityOptions]

operation. Specifies the name of the domain you want to describe. To show the active configuration and exclude any pending changes, set the Deployed option to true.

type nonrec analysis_scheme_language =
  1. | Zh_Hant
  2. | Zh_Hans
  3. | Tr
  4. | Th
  5. | Sv
  6. | Ru
  7. | Ro
  8. | Pt
  9. | No
  10. | Nl
  11. | Mul
  12. | Lv
  13. | Ko
  14. | Ja
  15. | It
  16. | Id
  17. | Hy
  18. | Hu
  19. | Hi
  20. | He
  21. | Gl
  22. | Ga
  23. | Fr
  24. | Fi
  25. | Fa
  26. | Eu
  27. | Es
  28. | En
  29. | El
  30. | De
  31. | Da
  32. | Cs
  33. | Ca
  34. | Bg
  35. | Ar

An IETF RFC 4646 language code or mul for multiple languages.

type nonrec algorithmic_stemming =
  1. | Full
  2. | Light
  3. | Minimal
  4. | None_
type nonrec analysis_options = {
  1. algorithmic_stemming : algorithmic_stemming option;
    (*

    The level of algorithmic stemming to perform: none, minimal, light, or full. The available levels vary depending on the language. For more information, see Language Specific Text Processing Settings in the Amazon CloudSearch Developer Guide

    *)
  2. japanese_tokenization_dictionary : string_ option;
    (*

    A JSON array that contains a collection of terms, tokens, readings and part of speech for Japanese Tokenizaiton. The Japanese tokenization dictionary enables you to override the default tokenization for selected terms. This is only valid for Japanese language fields.

    *)
  3. stemming_dictionary : string_ option;
    (*

    A JSON object that contains a collection of string:value pairs that each map a term to its stem. For example, {"term1": "stem1", "term2": "stem2", "term3": "stem3"}. The stemming dictionary is applied in addition to any algorithmic stemming. This enables you to override the results of the algorithmic stemming to correct specific cases of overstemming or understemming. The maximum size of a stemming dictionary is 500 KB.

    *)
  4. stopwords : string_ option;
    (*

    A JSON array of terms to ignore during indexing and searching. For example, ["a", "an", "the", "of"]. The stopwords dictionary must explicitly list each word you want to ignore. Wildcards and regular expressions are not supported.

    *)
  5. synonyms : string_ option;
    (*

    A JSON object that defines synonym groups and aliases. A synonym group is an array of arrays, where each sub-array is a group of terms where each term in the group is considered a synonym of every other term in the group. The aliases value is an object that contains a collection of string:value pairs where the string specifies a term and the array of values specifies each of the aliases for that term. An alias is considered a synonym of the specified term, but the term is not considered a synonym of the alias. For more information about specifying synonyms, see Synonyms in the Amazon CloudSearch Developer Guide.

    *)
}

Synonyms, stopwords, and stemming options for an analysis scheme. Includes tokenization dictionary for Japanese.

type nonrec analysis_scheme = {
  1. analysis_options : analysis_options option;
  2. analysis_scheme_language : analysis_scheme_language;
  3. analysis_scheme_name : standard_name;
}

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.

type nonrec analysis_scheme_status = {
  1. status : option_status;
  2. options : analysis_scheme;
}

The status and configuration of an AnalysisScheme.

type nonrec analysis_scheme_status_list = analysis_scheme_status list
type nonrec describe_analysis_schemes_response = {
  1. analysis_schemes : analysis_scheme_status_list;
    (*

    The analysis scheme descriptions.

    *)
}

The result of a DescribeAnalysisSchemes request. Contains the analysis schemes configured for the domain specified in the request.

type nonrec describe_analysis_schemes_request = {
  1. deployed : boolean_ option;
    (*

    Whether to display the deployed configuration (true) or include any pending changes (false). Defaults to false.

    *)
  2. analysis_scheme_names : standard_name_list option;
    (*

    The analysis schemes you want to describe.

    *)
  3. domain_name : domain_name;
    (*

    The name of the domain you want to describe.

    *)
}

Container for the parameters to the

[DescribeAnalysisSchemes]

operation. Specifies the name of the domain you want to describe. To limit the response to particular analysis schemes, specify the names of the analysis schemes you want to describe. To show the active configuration and exclude any pending changes, set the Deployed option to true.

type nonrec delete_suggester_response = {
  1. suggester : suggester_status;
    (*

    The status of the suggester being deleted.

    *)
}

The result of a DeleteSuggester request. Contains the status of the deleted suggester.

type nonrec delete_suggester_request = {
  1. suggester_name : standard_name;
    (*

    Specifies the name of the suggester you want to delete.

    *)
  2. domain_name : domain_name;
}

Container for the parameters to the

[DeleteSuggester]

operation. Specifies the name of the domain you want to update and name of the suggester you want to delete.

type nonrec delete_index_field_response = {
  1. index_field : index_field_status;
    (*

    The status of the index field being deleted.

    *)
}

The result of a

[DeleteIndexField]

request.

type nonrec delete_index_field_request = {
  1. index_field_name : dynamic_field_name;
    (*

    The name of the index field your want to remove from the domain's indexing options.

    *)
  2. domain_name : domain_name;
}

Container for the parameters to the

[DeleteIndexField]

operation. Specifies the name of the domain you want to update and the name of the index field you want to delete.

type nonrec delete_expression_response = {
  1. expression : expression_status;
    (*

    The status of the expression being deleted.

    *)
}

The result of a

[DeleteExpression]

request. Specifies the expression being deleted.

type nonrec delete_expression_request = {
  1. expression_name : standard_name;
    (*

    The name of the

    [Expression]

    to delete.

    *)
  2. domain_name : domain_name;
}

Container for the parameters to the

[DeleteExpression]

operation. Specifies the name of the domain you want to update and the name of the expression you want to delete.

type nonrec delete_domain_response = {
  1. domain_status : domain_status option;
}

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.

type nonrec delete_domain_request = {
  1. domain_name : domain_name;
    (*

    The name of the domain you want to permanently delete.

    *)
}

Container for the parameters to the

[DeleteDomain]

operation. Specifies the name of the domain you want to delete.

type nonrec delete_analysis_scheme_response = {
  1. analysis_scheme : analysis_scheme_status;
    (*

    The status of the analysis scheme being deleted.

    *)
}

The result of a DeleteAnalysisScheme request. Contains the status of the deleted analysis scheme.

type nonrec delete_analysis_scheme_request = {
  1. analysis_scheme_name : standard_name;
    (*

    The name of the analysis scheme you want to delete.

    *)
  2. domain_name : domain_name;
}

Container for the parameters to the

[DeleteAnalysisScheme]

operation. Specifies the name of the domain you want to update and the analysis scheme you want to delete.

type nonrec define_suggester_response = {
  1. suggester : suggester_status;
}

The result of a DefineSuggester request. Contains the status of the newly-configured suggester.

type nonrec define_suggester_request = {
  1. suggester : suggester;
  2. domain_name : domain_name;
}

Container for the parameters to the

[DefineSuggester]

operation. Specifies the name of the domain you want to update and the suggester configuration.

type nonrec define_index_field_response = {
  1. index_field : index_field_status;
}

The result of a

[DefineIndexField]

request. Contains the status of the newly-configured index field.

type nonrec define_index_field_request = {
  1. index_field : index_field;
    (*

    The index field and field options you want to configure.

    *)
  2. domain_name : domain_name;
}

Container for the parameters to the

[DefineIndexField]

operation. Specifies the name of the domain you want to update and the index field configuration.

type nonrec define_expression_response = {
  1. expression : expression_status;
}

The result of a DefineExpression request. Contains the status of the newly-configured expression.

type nonrec define_expression_request = {
  1. expression : expression;
  2. domain_name : domain_name;
}

Container for the parameters to the

[DefineExpression]

operation. Specifies the name of the domain you want to update and the expression you want to configure.

type nonrec define_analysis_scheme_response = {
  1. analysis_scheme : analysis_scheme_status;
}

The result of a

[DefineAnalysisScheme]

request. Contains the status of the newly-configured analysis scheme.

type nonrec define_analysis_scheme_request = {
  1. analysis_scheme : analysis_scheme;
  2. domain_name : domain_name;
}

Container for the parameters to the

[DefineAnalysisScheme]

operation. Specifies the name of the domain you want to update and the analysis scheme configuration.

type nonrec create_domain_response = {
  1. domain_status : domain_status option;
}

The result of a CreateDomainRequest. Contains the status of a newly created domain.

type nonrec create_domain_request = {
  1. domain_name : domain_name;
    (*

    A name for the domain you are creating. Allowed characters are a-z (lower-case letters), 0-9, and hyphen (-). Domain names must start with a letter or number and be at least 3 and no more than 28 characters long.

    *)
}

Container for the parameters to the

[CreateDomain]

operation. Specifies a name for the new search domain.

type nonrec build_suggesters_response = {
  1. field_names : field_name_list option;
}

The result of a BuildSuggester request. Contains a list of the fields used for suggestions.

type nonrec build_suggesters_request = {
  1. domain_name : domain_name;
}

Container for the parameters to the

[BuildSuggester]

operation. Specifies the name of the domain you want to update.