amazonka-cloudsearch-1.3.4: Amazon CloudSearch SDK.

Copyright(c) 2013-2015 Brendan Hay
LicenseMozilla Public License, v. 2.0.
MaintainerBrendan Hay <brendan.g.hay@gmail.com>
Stabilityauto-generated
Portabilitynon-portable (GHC extensions)
Safe HaskellNone
LanguageHaskell2010

Network.AWS.CloudSearch

Contents

Description

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.

See: AWS API Reference

Synopsis

Service Configuration

cloudSearch :: Service Source

API version '2013-01-01' of the Amazon CloudSearch SDK configuration.

Errors

Error matchers are designed for use with the functions provided by Control.Exception.Lens. This allows catching (and rethrowing) service specific errors returned by CloudSearch.

BaseException

_BaseException :: AsError a => Getting (First ServiceError) a ServiceError Source

An error occurred while processing the request.

DisabledOperationException

_DisabledOperationException :: AsError a => Getting (First ServiceError) a ServiceError Source

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

InternalException

_InternalException :: AsError a => Getting (First ServiceError) a ServiceError Source

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

InvalidTypeException

_InvalidTypeException :: AsError a => Getting (First ServiceError) a ServiceError Source

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

ResourceNotFoundException

_ResourceNotFoundException :: AsError a => Getting (First ServiceError) a ServiceError Source

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

LimitExceededException

_LimitExceededException :: AsError a => Getting (First ServiceError) a ServiceError Source

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

Waiters

Waiters poll by repeatedly sending a request until some remote success condition configured by the Wait specification is fulfilled. The Wait specification determines how many attempts should be made, in addition to delay and retry strategies.

Operations

Some AWS operations return results that are incomplete and require subsequent requests in order to obtain the entire result set. The process of sending subsequent requests to continue where a previous request left off is called pagination. For example, the ListObjects operation of Amazon S3 returns up to 1000 objects at a time, and you must send subsequent requests with the appropriate Marker in order to retrieve the next page of results.

Operations that have an AWSPager instance can transparently perform subsequent requests, correctly setting Markers and other request facets to iterate through the entire result set of a truncated API operation. Operations which support this have an additional note in the documentation.

Many operations have the ability to filter results on the server side. See the individual operation parameters for details.

DescribeAvailabilityOptions

module Network.AWS.CloudSearch.DescribeAvailabilityOptions

DescribeExpressions

module Network.AWS.CloudSearch.DescribeExpressions

DefineExpression

module Network.AWS.CloudSearch.DefineExpression

DescribeScalingParameters

module Network.AWS.CloudSearch.DescribeScalingParameters

DescribeServiceAccessPolicies

module Network.AWS.CloudSearch.DescribeServiceAccessPolicies

DescribeSuggesters

module Network.AWS.CloudSearch.DescribeSuggesters

UpdateAvailabilityOptions

module Network.AWS.CloudSearch.UpdateAvailabilityOptions

DeleteExpression

module Network.AWS.CloudSearch.DeleteExpression

ListDomainNames

module Network.AWS.CloudSearch.ListDomainNames

DefineSuggester

module Network.AWS.CloudSearch.DefineSuggester

DescribeDomains

module Network.AWS.CloudSearch.DescribeDomains

DeleteAnalysisScheme

module Network.AWS.CloudSearch.DeleteAnalysisScheme

DescribeAnalysisSchemes

module Network.AWS.CloudSearch.DescribeAnalysisSchemes

CreateDomain

module Network.AWS.CloudSearch.CreateDomain

DescribeIndexFields

module Network.AWS.CloudSearch.DescribeIndexFields

DeleteSuggester

module Network.AWS.CloudSearch.DeleteSuggester

DefineAnalysisScheme

module Network.AWS.CloudSearch.DefineAnalysisScheme

IndexDocuments

module Network.AWS.CloudSearch.IndexDocuments

DeleteIndexField

module Network.AWS.CloudSearch.DeleteIndexField

UpdateServiceAccessPolicies

module Network.AWS.CloudSearch.UpdateServiceAccessPolicies

UpdateScalingParameters

module Network.AWS.CloudSearch.UpdateScalingParameters

BuildSuggesters

module Network.AWS.CloudSearch.BuildSuggesters

DeleteDomain

module Network.AWS.CloudSearch.DeleteDomain

DefineIndexField

module Network.AWS.CloudSearch.DefineIndexField

Types

AlgorithmicStemming

data AlgorithmicStemming Source

Constructors

ASFull 
ASLight 
ASMinimal 
ASNone 

Instances

AnalysisSchemeLanguage

data AnalysisSchemeLanguage Source

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

Constructors

AR 
BG 
CA 
CS 
DA 
DE 
EL 
EN 
ES 
EU 
FA 
FI 
FR 
GA 
GL 
HE 
HI 
HU 
HY 
IT 
Id 
JA 
KO 
LV 
Mul 
NL 
NO 
PT 
RO 
RU 
SV 
TH 
TR 
ZhHans 
ZhHant 

Instances

IndexFieldType

data IndexFieldType Source

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.

Constructors

Date 
DateArray 
Double 
DoubleArray 
Int 
IntArray 
Latlon 
Literal 
LiteralArray 
Text 
TextArray 

Instances

OptionState

data OptionState Source

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.

Constructors

Active 
FailedToValidate 
Processing 
RequiresIndexDocuments 

Instances

PartitionInstanceType

data PartitionInstanceType Source

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

Constructors

Search_M1_Large 
Search_M1_Small 
Search_M2_2XLarge 
Search_M2_XLarge 
Search_M3_2XLarge 
Search_M3_Large 
Search_M3_Medium 
Search_M3_XLarge 

Instances

SuggesterFuzzyMatching

data SuggesterFuzzyMatching Source

Constructors

High 
Low 
None 

Instances

AccessPoliciesStatus

data AccessPoliciesStatus Source

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

See: accessPoliciesStatus smart constructor.

Instances

accessPoliciesStatus Source

Arguments

:: Text

apsOptions

-> OptionStatus

apsStatus

-> AccessPoliciesStatus 

Creates a value of AccessPoliciesStatus with the minimum fields required to make a request.

Use one of the following lenses to modify other fields as desired:

apsOptions :: Lens' AccessPoliciesStatus Text Source

Undocumented member.

apsStatus :: Lens' AccessPoliciesStatus OptionStatus Source

Undocumented member.

AnalysisOptions

data AnalysisOptions Source

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

See: analysisOptions smart constructor.

Instances

analysisOptions :: AnalysisOptions Source

Creates a value of AnalysisOptions with the minimum fields required to make a request.

Use one of the following lenses to modify other fields as desired:

aoAlgorithmicStemming :: Lens' AnalysisOptions (Maybe AlgorithmicStemming) Source

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

aoStopwords :: Lens' AnalysisOptions (Maybe Text) Source

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.

aoJapaneseTokenizationDictionary :: Lens' AnalysisOptions (Maybe Text) Source

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.

aoSynonyms :: Lens' AnalysisOptions (Maybe Text) Source

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.

aoStemmingDictionary :: Lens' AnalysisOptions (Maybe Text) Source

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.

AnalysisScheme

data AnalysisScheme Source

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.

See: analysisScheme smart constructor.

Instances

analysisScheme Source

Arguments

:: Text

asAnalysisSchemeName

-> AnalysisSchemeLanguage

asAnalysisSchemeLanguage

-> AnalysisScheme 

Creates a value of AnalysisScheme with the minimum fields required to make a request.

Use one of the following lenses to modify other fields as desired:

asAnalysisOptions :: Lens' AnalysisScheme (Maybe AnalysisOptions) Source

Undocumented member.

asAnalysisSchemeName :: Lens' AnalysisScheme Text Source

Undocumented member.

asAnalysisSchemeLanguage :: Lens' AnalysisScheme AnalysisSchemeLanguage Source

Undocumented member.

AnalysisSchemeStatus

data AnalysisSchemeStatus Source

The status and configuration of an AnalysisScheme.

See: analysisSchemeStatus smart constructor.

Instances

analysisSchemeStatus Source

Arguments

:: AnalysisScheme

assOptions

-> OptionStatus

assStatus

-> AnalysisSchemeStatus 

Creates a value of AnalysisSchemeStatus with the minimum fields required to make a request.

Use one of the following lenses to modify other fields as desired:

assOptions :: Lens' AnalysisSchemeStatus AnalysisScheme Source

Undocumented member.

assStatus :: Lens' AnalysisSchemeStatus OptionStatus Source

Undocumented member.

AvailabilityOptionsStatus

data AvailabilityOptionsStatus Source

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

See: availabilityOptionsStatus smart constructor.

Instances

availabilityOptionsStatus Source

Arguments

:: Bool

aosOptions

-> OptionStatus

aosStatus

-> AvailabilityOptionsStatus 

Creates a value of AvailabilityOptionsStatus with the minimum fields required to make a request.

Use one of the following lenses to modify other fields as desired:

aosOptions :: Lens' AvailabilityOptionsStatus Bool Source

The availability options configured for the domain.

aosStatus :: Lens' AvailabilityOptionsStatus OptionStatus Source

Undocumented member.

DateArrayOptions

data DateArrayOptions Source

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.

See: dateArrayOptions smart constructor.

Instances

dateArrayOptions :: DateArrayOptions Source

Creates a value of DateArrayOptions with the minimum fields required to make a request.

Use one of the following lenses to modify other fields as desired:

daosSourceFields :: Lens' DateArrayOptions (Maybe Text) Source

A list of source fields to map to the field.

daosReturnEnabled :: Lens' DateArrayOptions (Maybe Bool) Source

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

daosFacetEnabled :: Lens' DateArrayOptions (Maybe Bool) Source

Whether facet information can be returned for the field.

daosSearchEnabled :: Lens' DateArrayOptions (Maybe Bool) Source

Whether the contents of the field are searchable.

daosDefaultValue :: Lens' DateArrayOptions (Maybe Text) Source

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

DateOptions

data DateOptions Source

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.

See: dateOptions smart constructor.

Instances

dateOptions :: DateOptions Source

Creates a value of DateOptions with the minimum fields required to make a request.

Use one of the following lenses to modify other fields as desired:

doSourceField :: Lens' DateOptions (Maybe Text) Source

Undocumented member.

doReturnEnabled :: Lens' DateOptions (Maybe Bool) Source

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

doFacetEnabled :: Lens' DateOptions (Maybe Bool) Source

Whether facet information can be returned for the field.

doSearchEnabled :: Lens' DateOptions (Maybe Bool) Source

Whether the contents of the field are searchable.

doSortEnabled :: Lens' DateOptions (Maybe Bool) Source

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

doDefaultValue :: Lens' DateOptions (Maybe Text) Source

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

DocumentSuggesterOptions

data DocumentSuggesterOptions Source

Options for a search suggester.

See: documentSuggesterOptions smart constructor.

Instances

documentSuggesterOptions Source

Arguments

:: Text

dsoSourceField

-> DocumentSuggesterOptions 

Creates a value of DocumentSuggesterOptions with the minimum fields required to make a request.

Use one of the following lenses to modify other fields as desired:

dsoSortExpression :: Lens' DocumentSuggesterOptions (Maybe Text) Source

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.

dsoFuzzyMatching :: Lens' DocumentSuggesterOptions (Maybe SuggesterFuzzyMatching) Source

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.

dsoSourceField :: Lens' DocumentSuggesterOptions Text Source

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

DomainStatus

data DomainStatus Source

The current status of the search domain.

See: domainStatus smart constructor.

Instances

domainStatus Source

Arguments

:: Text

dsDomainId

-> Text

dsDomainName

-> Bool

dsRequiresIndexDocuments

-> DomainStatus 

Creates a value of DomainStatus with the minimum fields required to make a request.

Use one of the following lenses to modify other fields as desired:

dsSearchInstanceCount :: Lens' DomainStatus (Maybe Natural) Source

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

dsSearchInstanceType :: Lens' DomainStatus (Maybe Text) Source

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

dsDocService :: Lens' DomainStatus (Maybe ServiceEndpoint) Source

The service endpoint for updating documents in a search domain.

dsARN :: Lens' DomainStatus (Maybe Text) Source

Undocumented member.

dsCreated :: Lens' DomainStatus (Maybe Bool) Source

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.

dsSearchService :: Lens' DomainStatus (Maybe ServiceEndpoint) Source

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

dsLimits :: Lens' DomainStatus (Maybe Limits) Source

Undocumented member.

dsSearchPartitionCount :: Lens' DomainStatus (Maybe Natural) Source

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

dsDeleted :: Lens' DomainStatus (Maybe Bool) Source

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.

dsProcessing :: Lens' DomainStatus (Maybe Bool) Source

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

dsDomainId :: Lens' DomainStatus Text Source

Undocumented member.

dsDomainName :: Lens' DomainStatus Text Source

Undocumented member.

dsRequiresIndexDocuments :: Lens' DomainStatus Bool Source

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

DoubleArrayOptions

data DoubleArrayOptions Source

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.

See: doubleArrayOptions smart constructor.

Instances

doubleArrayOptions :: DoubleArrayOptions Source

Creates a value of DoubleArrayOptions with the minimum fields required to make a request.

Use one of the following lenses to modify other fields as desired:

daoSourceFields :: Lens' DoubleArrayOptions (Maybe Text) Source

A list of source fields to map to the field.

daoReturnEnabled :: Lens' DoubleArrayOptions (Maybe Bool) Source

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

daoFacetEnabled :: Lens' DoubleArrayOptions (Maybe Bool) Source

Whether facet information can be returned for the field.

daoSearchEnabled :: Lens' DoubleArrayOptions (Maybe Bool) Source

Whether the contents of the field are searchable.

daoDefaultValue :: Lens' DoubleArrayOptions (Maybe Double) Source

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

DoubleOptions

data DoubleOptions Source

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.

See: doubleOptions smart constructor.

Instances

doubleOptions :: DoubleOptions Source

Creates a value of DoubleOptions with the minimum fields required to make a request.

Use one of the following lenses to modify other fields as desired:

dSourceField :: Lens' DoubleOptions (Maybe Text) Source

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

dReturnEnabled :: Lens' DoubleOptions (Maybe Bool) Source

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

dFacetEnabled :: Lens' DoubleOptions (Maybe Bool) Source

Whether facet information can be returned for the field.

dSearchEnabled :: Lens' DoubleOptions (Maybe Bool) Source

Whether the contents of the field are searchable.

dSortEnabled :: Lens' DoubleOptions (Maybe Bool) Source

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

dDefaultValue :: Lens' DoubleOptions (Maybe Double) Source

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.

Expression

data Expression Source

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.

See: expression smart constructor.

Instances

expression Source

Arguments

:: Text

eExpressionName

-> Text

eExpressionValue

-> Expression 

Creates a value of Expression with the minimum fields required to make a request.

Use one of the following lenses to modify other fields as desired:

eExpressionName :: Lens' Expression Text Source

Undocumented member.

eExpressionValue :: Lens' Expression Text Source

Undocumented member.

ExpressionStatus

data ExpressionStatus Source

The value of an Expression and its current status.

See: expressionStatus smart constructor.

Instances

expressionStatus Source

Arguments

:: Expression

esOptions

-> OptionStatus

esStatus

-> ExpressionStatus 

Creates a value of ExpressionStatus with the minimum fields required to make a request.

Use one of the following lenses to modify other fields as desired:

esOptions :: Lens' ExpressionStatus Expression Source

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

esStatus :: Lens' ExpressionStatus OptionStatus Source

Undocumented member.

IndexField

data IndexField Source

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

See: indexField smart constructor.

Instances

indexField Source

Arguments

:: Text

ifIndexFieldName

-> IndexFieldType

ifIndexFieldType

-> IndexField 

Creates a value of IndexField with the minimum fields required to make a request.

Use one of the following lenses to modify other fields as desired:

ifDoubleArrayOptions :: Lens' IndexField (Maybe DoubleArrayOptions) Source

Undocumented member.

ifDateOptions :: Lens' IndexField (Maybe DateOptions) Source

Undocumented member.

ifTextArrayOptions :: Lens' IndexField (Maybe TextArrayOptions) Source

Undocumented member.

ifDoubleOptions :: Lens' IndexField (Maybe DoubleOptions) Source

Undocumented member.

ifTextOptions :: Lens' IndexField (Maybe TextOptions) Source

Undocumented member.

ifLatLonOptions :: Lens' IndexField (Maybe LatLonOptions) Source

Undocumented member.

ifLiteralArrayOptions :: Lens' IndexField (Maybe LiteralArrayOptions) Source

Undocumented member.

ifIntArrayOptions :: Lens' IndexField (Maybe IntArrayOptions) Source

Undocumented member.

ifDateArrayOptions :: Lens' IndexField (Maybe DateArrayOptions) Source

Undocumented member.

ifIntOptions :: Lens' IndexField (Maybe IntOptions) Source

Undocumented member.

ifLiteralOptions :: Lens' IndexField (Maybe LiteralOptions) Source

Undocumented member.

ifIndexFieldName :: Lens' IndexField Text Source

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.

ifIndexFieldType :: Lens' IndexField IndexFieldType Source

Undocumented member.

IndexFieldStatus

data IndexFieldStatus Source

The value of an IndexField and its current status.

See: indexFieldStatus smart constructor.

Instances

indexFieldStatus Source

Arguments

:: IndexField

ifsOptions

-> OptionStatus

ifsStatus

-> IndexFieldStatus 

Creates a value of IndexFieldStatus with the minimum fields required to make a request.

Use one of the following lenses to modify other fields as desired:

ifsOptions :: Lens' IndexFieldStatus IndexField Source

Undocumented member.

ifsStatus :: Lens' IndexFieldStatus OptionStatus Source

Undocumented member.

IntArrayOptions

data IntArrayOptions Source

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.

See: intArrayOptions smart constructor.

Instances

intArrayOptions :: IntArrayOptions Source

Creates a value of IntArrayOptions with the minimum fields required to make a request.

Use one of the following lenses to modify other fields as desired:

iaoSourceFields :: Lens' IntArrayOptions (Maybe Text) Source

A list of source fields to map to the field.

iaoReturnEnabled :: Lens' IntArrayOptions (Maybe Bool) Source

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

iaoFacetEnabled :: Lens' IntArrayOptions (Maybe Bool) Source

Whether facet information can be returned for the field.

iaoSearchEnabled :: Lens' IntArrayOptions (Maybe Bool) Source

Whether the contents of the field are searchable.

iaoDefaultValue :: Lens' IntArrayOptions (Maybe Integer) Source

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

IntOptions

data IntOptions Source

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

See: intOptions smart constructor.

Instances

intOptions :: IntOptions Source

Creates a value of IntOptions with the minimum fields required to make a request.

Use one of the following lenses to modify other fields as desired:

ioSourceField :: Lens' IntOptions (Maybe Text) Source

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

ioReturnEnabled :: Lens' IntOptions (Maybe Bool) Source

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

ioFacetEnabled :: Lens' IntOptions (Maybe Bool) Source

Whether facet information can be returned for the field.

ioSearchEnabled :: Lens' IntOptions (Maybe Bool) Source

Whether the contents of the field are searchable.

ioSortEnabled :: Lens' IntOptions (Maybe Bool) Source

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

ioDefaultValue :: Lens' IntOptions (Maybe Integer) Source

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.

LatLonOptions

data LatLonOptions Source

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.

See: latLonOptions smart constructor.

Instances

latLonOptions :: LatLonOptions Source

Creates a value of LatLonOptions with the minimum fields required to make a request.

Use one of the following lenses to modify other fields as desired:

lloSourceField :: Lens' LatLonOptions (Maybe Text) Source

Undocumented member.

lloReturnEnabled :: Lens' LatLonOptions (Maybe Bool) Source

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

lloFacetEnabled :: Lens' LatLonOptions (Maybe Bool) Source

Whether facet information can be returned for the field.

lloSearchEnabled :: Lens' LatLonOptions (Maybe Bool) Source

Whether the contents of the field are searchable.

lloSortEnabled :: Lens' LatLonOptions (Maybe Bool) Source

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

lloDefaultValue :: Lens' LatLonOptions (Maybe Text) Source

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

Limits

data Limits Source

See: limits smart constructor.

Instances

limits Source

Arguments

:: Natural

lMaximumReplicationCount

-> Natural

lMaximumPartitionCount

-> Limits 

Creates a value of Limits with the minimum fields required to make a request.

Use one of the following lenses to modify other fields as desired:

lMaximumReplicationCount :: Lens' Limits Natural Source

Undocumented member.

lMaximumPartitionCount :: Lens' Limits Natural Source

Undocumented member.

LiteralArrayOptions

data LiteralArrayOptions Source

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.

See: literalArrayOptions smart constructor.

Instances

literalArrayOptions :: LiteralArrayOptions Source

Creates a value of LiteralArrayOptions with the minimum fields required to make a request.

Use one of the following lenses to modify other fields as desired:

laoSourceFields :: Lens' LiteralArrayOptions (Maybe Text) Source

A list of source fields to map to the field.

laoReturnEnabled :: Lens' LiteralArrayOptions (Maybe Bool) Source

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

laoFacetEnabled :: Lens' LiteralArrayOptions (Maybe Bool) Source

Whether facet information can be returned for the field.

laoSearchEnabled :: Lens' LiteralArrayOptions (Maybe Bool) Source

Whether the contents of the field are searchable.

laoDefaultValue :: Lens' LiteralArrayOptions (Maybe Text) Source

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

LiteralOptions

data LiteralOptions Source

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

See: literalOptions smart constructor.

Instances

literalOptions :: LiteralOptions Source

Creates a value of LiteralOptions with the minimum fields required to make a request.

Use one of the following lenses to modify other fields as desired:

loSourceField :: Lens' LiteralOptions (Maybe Text) Source

Undocumented member.

loReturnEnabled :: Lens' LiteralOptions (Maybe Bool) Source

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

loFacetEnabled :: Lens' LiteralOptions (Maybe Bool) Source

Whether facet information can be returned for the field.

loSearchEnabled :: Lens' LiteralOptions (Maybe Bool) Source

Whether the contents of the field are searchable.

loSortEnabled :: Lens' LiteralOptions (Maybe Bool) Source

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

loDefaultValue :: Lens' LiteralOptions (Maybe Text) Source

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

OptionStatus

data OptionStatus Source

The status of domain configuration option.

See: optionStatus smart constructor.

Instances

optionStatus Source

Arguments

:: UTCTime

osCreationDate

-> UTCTime

osUpdateDate

-> OptionState

osState

-> OptionStatus 

Creates a value of OptionStatus with the minimum fields required to make a request.

Use one of the following lenses to modify other fields as desired:

osPendingDeletion :: Lens' OptionStatus (Maybe Bool) Source

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

osUpdateVersion :: Lens' OptionStatus (Maybe Natural) Source

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

osCreationDate :: Lens' OptionStatus UTCTime Source

A timestamp for when this option was created.

osUpdateDate :: Lens' OptionStatus UTCTime Source

A timestamp for when this option was last updated.

osState :: Lens' OptionStatus OptionState Source

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.

ScalingParameters

data ScalingParameters Source

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

See: scalingParameters smart constructor.

Instances

scalingParameters :: ScalingParameters Source

Creates a value of ScalingParameters with the minimum fields required to make a request.

Use one of the following lenses to modify other fields as desired:

spDesiredInstanceType :: Lens' ScalingParameters (Maybe PartitionInstanceType) Source

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

spDesiredReplicationCount :: Lens' ScalingParameters (Maybe Natural) Source

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

spDesiredPartitionCount :: Lens' ScalingParameters (Maybe Natural) Source

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

ScalingParametersStatus

data ScalingParametersStatus Source

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

See: scalingParametersStatus smart constructor.

Instances

scalingParametersStatus Source

Arguments

:: ScalingParameters

spsOptions

-> OptionStatus

spsStatus

-> ScalingParametersStatus 

Creates a value of ScalingParametersStatus with the minimum fields required to make a request.

Use one of the following lenses to modify other fields as desired:

spsOptions :: Lens' ScalingParametersStatus ScalingParameters Source

Undocumented member.

spsStatus :: Lens' ScalingParametersStatus OptionStatus Source

Undocumented member.

ServiceEndpoint

data ServiceEndpoint Source

The endpoint to which service requests can be submitted.

See: serviceEndpoint smart constructor.

Instances

serviceEndpoint :: ServiceEndpoint Source

Creates a value of ServiceEndpoint with the minimum fields required to make a request.

Use one of the following lenses to modify other fields as desired:

seEndpoint :: Lens' ServiceEndpoint (Maybe Text) Source

Undocumented member.

Suggester

data Suggester Source

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.

See: suggester smart constructor.

Instances

suggester Source

Arguments

:: Text

sSuggesterName

-> DocumentSuggesterOptions

sDocumentSuggesterOptions

-> Suggester 

Creates a value of Suggester with the minimum fields required to make a request.

Use one of the following lenses to modify other fields as desired:

sSuggesterName :: Lens' Suggester Text Source

Undocumented member.

sDocumentSuggesterOptions :: Lens' Suggester DocumentSuggesterOptions Source

Undocumented member.

SuggesterStatus

data SuggesterStatus Source

The value of a Suggester and its current status.

See: suggesterStatus smart constructor.

Instances

suggesterStatus Source

Arguments

:: Suggester

ssOptions

-> OptionStatus

ssStatus

-> SuggesterStatus 

Creates a value of SuggesterStatus with the minimum fields required to make a request.

Use one of the following lenses to modify other fields as desired:

ssOptions :: Lens' SuggesterStatus Suggester Source

Undocumented member.

ssStatus :: Lens' SuggesterStatus OptionStatus Source

Undocumented member.

TextArrayOptions

data TextArrayOptions Source

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.

See: textArrayOptions smart constructor.

Instances

textArrayOptions :: TextArrayOptions Source

Creates a value of TextArrayOptions with the minimum fields required to make a request.

Use one of the following lenses to modify other fields as desired:

taoSourceFields :: Lens' TextArrayOptions (Maybe Text) Source

A list of source fields to map to the field.

taoReturnEnabled :: Lens' TextArrayOptions (Maybe Bool) Source

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

taoAnalysisScheme :: Lens' TextArrayOptions (Maybe Text) Source

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

taoHighlightEnabled :: Lens' TextArrayOptions (Maybe Bool) Source

Whether highlights can be returned for the field.

taoDefaultValue :: Lens' TextArrayOptions (Maybe Text) Source

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

TextOptions

data TextOptions Source

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.

See: textOptions smart constructor.

Instances

textOptions :: TextOptions Source

Creates a value of TextOptions with the minimum fields required to make a request.

Use one of the following lenses to modify other fields as desired:

toSourceField :: Lens' TextOptions (Maybe Text) Source

Undocumented member.

toReturnEnabled :: Lens' TextOptions (Maybe Bool) Source

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

toAnalysisScheme :: Lens' TextOptions (Maybe Text) Source

The name of an analysis scheme for a text field.

toHighlightEnabled :: Lens' TextOptions (Maybe Bool) Source

Whether highlights can be returned for the field.

toSortEnabled :: Lens' TextOptions (Maybe Bool) Source

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

toDefaultValue :: Lens' TextOptions (Maybe Text) Source

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