Module Awso_cloudsearch.ValuesSource

Sourceval service : Awso.Service.t
Sourceval apiVersion : string
Sourceval endpointPrefix : string
Sourceval serviceFullName : string
Sourceval signatureVersion : string
Sourceval protocol : string
Sourceval globalEndpoint : string
Sourceval xmlNamespace : string
Sourceval simple_to_json : ('a -> Awso__Botodata.value) -> 'a -> Yojson.Safe.t
Sourceval composed_to_json : ('a -> Awso__Botodata.value) -> 'a -> Yojson.Safe.t
Sourceval to_query : ('a -> Awso.Client.Query.value) -> 'a -> Awso.Client.Query.t
Sourceval structure_to_value_aux : ('a * 'b option) list -> f:(('a * 'b) list -> 'c) -> [> `Structure of 'c ]
Sourceval structure_to_value : ('a * 'b option) list -> [> `Structure of ('a * 'b) list ]
Sourceval structure_to_wrapped_value : wrapper:'a -> response:'a -> ('b * 'c option) list -> [> `Structure of ('a * [> `Structure of ('b * 'c) list ]) list ]
Sourcemodule FieldName : sig ... end

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.

Sourcemodule String_ : sig ... end
Sourcemodule SuggesterFuzzyMatching : sig ... end
Sourcemodule Boolean : sig ... end
Sourcemodule FieldNameCommaList : sig ... end
Sourcemodule FieldValue : sig ... end

The value of a field attribute.

Sourcemodule Double : sig ... end
Sourcemodule Long : sig ... end
Sourcemodule Word : sig ... end
Sourcemodule AlgorithmicStemming : sig ... end
Sourcemodule OptionState : sig ... end
Sourcemodule UIntValue : sig ... end
Sourcemodule UpdateTimestamp : sig ... end
Sourcemodule DocumentSuggesterOptions : sig ... end

Options for a search suggester.

Sourcemodule StandardName : sig ... end

Names must begin with a letter and can contain the following characters: a-z (lowercase), 0-9, and _ (underscore).

Sourcemodule DateArrayOptions : sig ... end

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.

Sourcemodule DateOptions : sig ... end

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.

Sourcemodule DoubleArrayOptions : sig ... end

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.

Sourcemodule DoubleOptions : sig ... end

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.

Sourcemodule DynamicFieldName : sig ... end
Sourcemodule IndexFieldType : sig ... end
Sourcemodule IntArrayOptions : sig ... end

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.

Sourcemodule IntOptions : sig ... end

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

Sourcemodule LatLonOptions : sig ... end

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.

Sourcemodule LiteralArrayOptions : sig ... end

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.

Sourcemodule LiteralOptions : sig ... end

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

Sourcemodule TextArrayOptions : sig ... end

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.

Sourcemodule TextOptions : sig ... end

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.

Sourcemodule ExpressionValue : sig ... end

The expression to evaluate for sorting while processing a search request. The Expression syntax is based on JavaScript expressions. For more information, see Configuring Expressions in the Amazon CloudSearch Developer Guide.

Sourcemodule MaximumPartitionCount : sig ... end
Sourcemodule MaximumReplicationCount : sig ... end
Sourcemodule ServiceUrl : sig ... end

The endpoint to which service requests can be submitted. For example, search-imdb-movies-oopcnjfn6ugofer3zx5iadxxca.eu-west-1.cloudsearch.amazonaws.com or doc-imdb-movies-oopcnjfn6ugofer3zx5iadxxca.eu-west-1.cloudsearch.amazonaws.com.

Sourcemodule AnalysisOptions : sig ... end

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

Sourcemodule AnalysisSchemeLanguage : sig ... end
Sourcemodule PartitionInstanceType : sig ... end
Sourcemodule TLSSecurityPolicy : sig ... end
Sourcemodule OptionStatus : sig ... end

The status of domain configuration option.

Sourcemodule Suggester : sig ... end

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.

Sourcemodule IndexField : sig ... end

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

Sourcemodule Expression : sig ... end

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.

Sourcemodule ARN : sig ... end

The Amazon Resource Name (ARN) of the search domain. See Identifiers for IAM Entities in Using AWS Identity and Access Management for more information.

Sourcemodule DomainId : sig ... end

An internally generated unique identifier for a domain.

Sourcemodule DomainName : sig ... end

A string that represents the name of a domain. Domain names are unique across the domains owned by an account within an AWS region. Domain names start with a letter or number and can contain the following characters: a-z (lowercase), 0-9, and - (hyphen).

Sourcemodule InstanceCount : sig ... end
Sourcemodule Limits : sig ... end
Sourcemodule PartitionCount : sig ... end

The number of partitions used to hold the domain's index.

Sourcemodule SearchInstanceType : sig ... end

The instance type (such as search.m1.small) that is being used to process search requests.

Sourcemodule ServiceEndpoint : sig ... end

The endpoint to which service requests can be submitted.

Sourcemodule AnalysisScheme : sig ... end

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.

Sourcemodule PolicyDocument : sig ... end

Access rules for a domain's document or search service endpoints. For more information, see Configuring Access for a Search Domain in the Amazon CloudSearch Developer Guide. The maximum size of a policy document is 100 KB.

Sourcemodule ErrorCode : sig ... end

A machine-parsable string error or warning code.

Sourcemodule ErrorMessage : sig ... end

A human-readable string error or warning message.

Sourcemodule ScalingParameters : sig ... end

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

Sourcemodule DomainEndpointOptions : sig ... end

The domain's endpoint options.

Sourcemodule MultiAZ : sig ... end
Sourcemodule APIVersion : sig ... end

The Amazon CloudSearch API version for a domain: 2011-02-01 or 2013-01-01.

Sourcemodule SuggesterStatus : sig ... end

The value of a Suggester and its current status.

Sourcemodule IndexFieldStatus : sig ... end

The value of an IndexField and its current status.

Sourcemodule ExpressionStatus : sig ... end

The value of an Expression and its current status.

Sourcemodule DomainStatus : sig ... end

The current status of the search domain.

Sourcemodule AnalysisSchemeStatus : sig ... end

The status and configuration of an AnalysisScheme.

Sourcemodule AccessPoliciesStatus : sig ... end

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

Sourcemodule BaseException : sig ... end

An error occurred while processing the request.

Sourcemodule InternalException : sig ... end

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

Sourcemodule InvalidTypeException : sig ... end

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

Sourcemodule LimitExceededException : sig ... end

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

Sourcemodule ResourceNotFoundException : sig ... end

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

Sourcemodule ValidationException : sig ... end

The request was rejected because it has invalid parameters.

Sourcemodule ScalingParametersStatus : sig ... end

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

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

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

Sourcemodule AvailabilityOptionsStatus : sig ... end

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

Sourcemodule DomainNameMap : sig ... end
Sourcemodule FieldNameList : sig ... end
Sourcemodule SuggesterStatusList : sig ... end
Sourcemodule StandardNameList : sig ... end
Sourcemodule IndexFieldStatusList : sig ... end
Sourcemodule DynamicFieldNameList : sig ... end
Sourcemodule ExpressionStatusList : sig ... end
Sourcemodule DomainStatusList : sig ... end
Sourcemodule DomainNameList : sig ... end
Sourcemodule AnalysisSchemeStatusList : sig ... end

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

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

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.

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

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.

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

Container for the parameters to the UpdateDomainEndpointOptions operation. Specifies the name of the domain you want to update and the domain endpoint options.

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

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

Sourcemodule ListDomainNamesResponse : sig ... end

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

Sourcemodule IndexDocumentsResponse : sig ... end

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

Sourcemodule IndexDocumentsRequest : sig ... end

Container for the parameters to the IndexDocuments operation. Specifies the name of the domain you want to re-index.

The result of a DescribeSuggesters request.

Sourcemodule DescribeSuggestersRequest : sig ... end

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.

The result of a DescribeServiceAccessPolicies request.

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.

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

Container for the parameters to the DescribeScalingParameters operation. Specifies the name of the domain you want to describe.

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

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.

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

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.

Sourcemodule DescribeDomainsResponse : sig ... end

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

Sourcemodule DescribeDomainsRequest : sig ... end

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.

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

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.

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

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.

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

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.

Sourcemodule DeleteSuggesterResponse : sig ... end

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

Sourcemodule DeleteSuggesterRequest : sig ... end

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.

Sourcemodule DeleteIndexFieldResponse : sig ... end

The result of a DeleteIndexField request.

Sourcemodule DeleteIndexFieldRequest : sig ... end

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.

Sourcemodule DeleteExpressionResponse : sig ... end

The result of a DeleteExpression request. Specifies the expression being deleted.

Sourcemodule DeleteExpressionRequest : sig ... end

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.

Sourcemodule DeleteDomainResponse : sig ... end

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.

Sourcemodule DeleteDomainRequest : sig ... end

Container for the parameters to the DeleteDomain operation. Specifies the name of the domain you want to delete.

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

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.

Sourcemodule DefineSuggesterResponse : sig ... end

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

Sourcemodule DefineSuggesterRequest : sig ... end

Container for the parameters to the DefineSuggester operation. Specifies the name of the domain you want to update and the suggester configuration.

Sourcemodule DefineIndexFieldResponse : sig ... end

The result of a DefineIndexField request. Contains the status of the newly-configured index field.

Sourcemodule DefineIndexFieldRequest : sig ... end

Container for the parameters to the DefineIndexField operation. Specifies the name of the domain you want to update and the index field configuration.

Sourcemodule DefineExpressionResponse : sig ... end

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

Sourcemodule DefineExpressionRequest : sig ... end

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.

The result of a DefineAnalysisScheme request. Contains the status of the newly-configured analysis scheme.

Container for the parameters to the DefineAnalysisScheme operation. Specifies the name of the domain you want to update and the analysis scheme configuration.

Sourcemodule CreateDomainResponse : sig ... end

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

Sourcemodule CreateDomainRequest : sig ... end

Container for the parameters to the CreateDomain operation. Specifies a name for the new search domain.

Sourcemodule BuildSuggestersResponse : sig ... end

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

Sourcemodule BuildSuggestersRequest : sig ... end

Container for the parameters to the BuildSuggester operation. Specifies the name of the domain you want to update.