| Copyright | (c) 2013-2016 Brendan Hay |
|---|---|
| License | Mozilla Public License, v. 2.0. |
| Maintainer | Brendan Hay <brendan.g.hay@gmail.com> |
| Stability | auto-generated |
| Portability | non-portable (GHC extensions) |
| Safe Haskell | None |
| Language | Haskell2010 |
Network.AWS.CloudSearch.Types
Contents
- Service Configuration
- Errors
- AlgorithmicStemming
- AnalysisSchemeLanguage
- IndexFieldType
- OptionState
- PartitionInstanceType
- SuggesterFuzzyMatching
- AccessPoliciesStatus
- AnalysisOptions
- AnalysisScheme
- AnalysisSchemeStatus
- AvailabilityOptionsStatus
- DateArrayOptions
- DateOptions
- DocumentSuggesterOptions
- DomainStatus
- DoubleArrayOptions
- DoubleOptions
- Expression
- ExpressionStatus
- IndexField
- IndexFieldStatus
- IntArrayOptions
- IntOptions
- LatLonOptions
- Limits
- LiteralArrayOptions
- LiteralOptions
- OptionStatus
- ScalingParameters
- ScalingParametersStatus
- ServiceEndpoint
- Suggester
- SuggesterStatus
- TextArrayOptions
- TextOptions
Description
- cloudSearch :: Service
- _BaseException :: AsError a => Getting (First ServiceError) a ServiceError
- _DisabledOperationException :: AsError a => Getting (First ServiceError) a ServiceError
- _InternalException :: AsError a => Getting (First ServiceError) a ServiceError
- _InvalidTypeException :: AsError a => Getting (First ServiceError) a ServiceError
- _ResourceNotFoundException :: AsError a => Getting (First ServiceError) a ServiceError
- _LimitExceededException :: AsError a => Getting (First ServiceError) a ServiceError
- data AlgorithmicStemming
- data AnalysisSchemeLanguage
- data IndexFieldType
- data OptionState
- data PartitionInstanceType
- data SuggesterFuzzyMatching
- data AccessPoliciesStatus
- accessPoliciesStatus :: Text -> OptionStatus -> AccessPoliciesStatus
- apsOptions :: Lens' AccessPoliciesStatus Text
- apsStatus :: Lens' AccessPoliciesStatus OptionStatus
- data AnalysisOptions
- analysisOptions :: AnalysisOptions
- aoAlgorithmicStemming :: Lens' AnalysisOptions (Maybe AlgorithmicStemming)
- aoStopwords :: Lens' AnalysisOptions (Maybe Text)
- aoJapaneseTokenizationDictionary :: Lens' AnalysisOptions (Maybe Text)
- aoSynonyms :: Lens' AnalysisOptions (Maybe Text)
- aoStemmingDictionary :: Lens' AnalysisOptions (Maybe Text)
- data AnalysisScheme
- analysisScheme :: Text -> AnalysisSchemeLanguage -> AnalysisScheme
- asAnalysisOptions :: Lens' AnalysisScheme (Maybe AnalysisOptions)
- asAnalysisSchemeName :: Lens' AnalysisScheme Text
- asAnalysisSchemeLanguage :: Lens' AnalysisScheme AnalysisSchemeLanguage
- data AnalysisSchemeStatus
- analysisSchemeStatus :: AnalysisScheme -> OptionStatus -> AnalysisSchemeStatus
- assOptions :: Lens' AnalysisSchemeStatus AnalysisScheme
- assStatus :: Lens' AnalysisSchemeStatus OptionStatus
- data AvailabilityOptionsStatus
- availabilityOptionsStatus :: Bool -> OptionStatus -> AvailabilityOptionsStatus
- aosOptions :: Lens' AvailabilityOptionsStatus Bool
- aosStatus :: Lens' AvailabilityOptionsStatus OptionStatus
- data DateArrayOptions
- dateArrayOptions :: DateArrayOptions
- daosSourceFields :: Lens' DateArrayOptions (Maybe Text)
- daosReturnEnabled :: Lens' DateArrayOptions (Maybe Bool)
- daosFacetEnabled :: Lens' DateArrayOptions (Maybe Bool)
- daosSearchEnabled :: Lens' DateArrayOptions (Maybe Bool)
- daosDefaultValue :: Lens' DateArrayOptions (Maybe Text)
- data DateOptions
- dateOptions :: DateOptions
- doSourceField :: Lens' DateOptions (Maybe Text)
- doReturnEnabled :: Lens' DateOptions (Maybe Bool)
- doFacetEnabled :: Lens' DateOptions (Maybe Bool)
- doSearchEnabled :: Lens' DateOptions (Maybe Bool)
- doSortEnabled :: Lens' DateOptions (Maybe Bool)
- doDefaultValue :: Lens' DateOptions (Maybe Text)
- data DocumentSuggesterOptions
- documentSuggesterOptions :: Text -> DocumentSuggesterOptions
- dsoSortExpression :: Lens' DocumentSuggesterOptions (Maybe Text)
- dsoFuzzyMatching :: Lens' DocumentSuggesterOptions (Maybe SuggesterFuzzyMatching)
- dsoSourceField :: Lens' DocumentSuggesterOptions Text
- data DomainStatus
- domainStatus :: Text -> Text -> Bool -> DomainStatus
- dsSearchInstanceCount :: Lens' DomainStatus (Maybe Natural)
- dsSearchInstanceType :: Lens' DomainStatus (Maybe Text)
- dsDocService :: Lens' DomainStatus (Maybe ServiceEndpoint)
- dsARN :: Lens' DomainStatus (Maybe Text)
- dsCreated :: Lens' DomainStatus (Maybe Bool)
- dsSearchService :: Lens' DomainStatus (Maybe ServiceEndpoint)
- dsLimits :: Lens' DomainStatus (Maybe Limits)
- dsSearchPartitionCount :: Lens' DomainStatus (Maybe Natural)
- dsDeleted :: Lens' DomainStatus (Maybe Bool)
- dsProcessing :: Lens' DomainStatus (Maybe Bool)
- dsDomainId :: Lens' DomainStatus Text
- dsDomainName :: Lens' DomainStatus Text
- dsRequiresIndexDocuments :: Lens' DomainStatus Bool
- data DoubleArrayOptions
- doubleArrayOptions :: DoubleArrayOptions
- daoSourceFields :: Lens' DoubleArrayOptions (Maybe Text)
- daoReturnEnabled :: Lens' DoubleArrayOptions (Maybe Bool)
- daoFacetEnabled :: Lens' DoubleArrayOptions (Maybe Bool)
- daoSearchEnabled :: Lens' DoubleArrayOptions (Maybe Bool)
- daoDefaultValue :: Lens' DoubleArrayOptions (Maybe Double)
- data DoubleOptions
- doubleOptions :: DoubleOptions
- dSourceField :: Lens' DoubleOptions (Maybe Text)
- dReturnEnabled :: Lens' DoubleOptions (Maybe Bool)
- dFacetEnabled :: Lens' DoubleOptions (Maybe Bool)
- dSearchEnabled :: Lens' DoubleOptions (Maybe Bool)
- dSortEnabled :: Lens' DoubleOptions (Maybe Bool)
- dDefaultValue :: Lens' DoubleOptions (Maybe Double)
- data Expression
- expression :: Text -> Text -> Expression
- eExpressionName :: Lens' Expression Text
- eExpressionValue :: Lens' Expression Text
- data ExpressionStatus
- expressionStatus :: Expression -> OptionStatus -> ExpressionStatus
- esOptions :: Lens' ExpressionStatus Expression
- esStatus :: Lens' ExpressionStatus OptionStatus
- data IndexField
- indexField :: Text -> IndexFieldType -> IndexField
- ifDoubleArrayOptions :: Lens' IndexField (Maybe DoubleArrayOptions)
- ifDateOptions :: Lens' IndexField (Maybe DateOptions)
- ifTextArrayOptions :: Lens' IndexField (Maybe TextArrayOptions)
- ifDoubleOptions :: Lens' IndexField (Maybe DoubleOptions)
- ifTextOptions :: Lens' IndexField (Maybe TextOptions)
- ifLatLonOptions :: Lens' IndexField (Maybe LatLonOptions)
- ifLiteralArrayOptions :: Lens' IndexField (Maybe LiteralArrayOptions)
- ifIntArrayOptions :: Lens' IndexField (Maybe IntArrayOptions)
- ifDateArrayOptions :: Lens' IndexField (Maybe DateArrayOptions)
- ifIntOptions :: Lens' IndexField (Maybe IntOptions)
- ifLiteralOptions :: Lens' IndexField (Maybe LiteralOptions)
- ifIndexFieldName :: Lens' IndexField Text
- ifIndexFieldType :: Lens' IndexField IndexFieldType
- data IndexFieldStatus
- indexFieldStatus :: IndexField -> OptionStatus -> IndexFieldStatus
- ifsOptions :: Lens' IndexFieldStatus IndexField
- ifsStatus :: Lens' IndexFieldStatus OptionStatus
- data IntArrayOptions
- intArrayOptions :: IntArrayOptions
- iaoSourceFields :: Lens' IntArrayOptions (Maybe Text)
- iaoReturnEnabled :: Lens' IntArrayOptions (Maybe Bool)
- iaoFacetEnabled :: Lens' IntArrayOptions (Maybe Bool)
- iaoSearchEnabled :: Lens' IntArrayOptions (Maybe Bool)
- iaoDefaultValue :: Lens' IntArrayOptions (Maybe Integer)
- data IntOptions
- intOptions :: IntOptions
- ioSourceField :: Lens' IntOptions (Maybe Text)
- ioReturnEnabled :: Lens' IntOptions (Maybe Bool)
- ioFacetEnabled :: Lens' IntOptions (Maybe Bool)
- ioSearchEnabled :: Lens' IntOptions (Maybe Bool)
- ioSortEnabled :: Lens' IntOptions (Maybe Bool)
- ioDefaultValue :: Lens' IntOptions (Maybe Integer)
- data LatLonOptions
- latLonOptions :: LatLonOptions
- lloSourceField :: Lens' LatLonOptions (Maybe Text)
- lloReturnEnabled :: Lens' LatLonOptions (Maybe Bool)
- lloFacetEnabled :: Lens' LatLonOptions (Maybe Bool)
- lloSearchEnabled :: Lens' LatLonOptions (Maybe Bool)
- lloSortEnabled :: Lens' LatLonOptions (Maybe Bool)
- lloDefaultValue :: Lens' LatLonOptions (Maybe Text)
- data Limits
- limits :: Natural -> Natural -> Limits
- lMaximumReplicationCount :: Lens' Limits Natural
- lMaximumPartitionCount :: Lens' Limits Natural
- data LiteralArrayOptions
- literalArrayOptions :: LiteralArrayOptions
- laoSourceFields :: Lens' LiteralArrayOptions (Maybe Text)
- laoReturnEnabled :: Lens' LiteralArrayOptions (Maybe Bool)
- laoFacetEnabled :: Lens' LiteralArrayOptions (Maybe Bool)
- laoSearchEnabled :: Lens' LiteralArrayOptions (Maybe Bool)
- laoDefaultValue :: Lens' LiteralArrayOptions (Maybe Text)
- data LiteralOptions
- literalOptions :: LiteralOptions
- loSourceField :: Lens' LiteralOptions (Maybe Text)
- loReturnEnabled :: Lens' LiteralOptions (Maybe Bool)
- loFacetEnabled :: Lens' LiteralOptions (Maybe Bool)
- loSearchEnabled :: Lens' LiteralOptions (Maybe Bool)
- loSortEnabled :: Lens' LiteralOptions (Maybe Bool)
- loDefaultValue :: Lens' LiteralOptions (Maybe Text)
- data OptionStatus
- optionStatus :: UTCTime -> UTCTime -> OptionState -> OptionStatus
- osPendingDeletion :: Lens' OptionStatus (Maybe Bool)
- osUpdateVersion :: Lens' OptionStatus (Maybe Natural)
- osCreationDate :: Lens' OptionStatus UTCTime
- osUpdateDate :: Lens' OptionStatus UTCTime
- osState :: Lens' OptionStatus OptionState
- data ScalingParameters
- scalingParameters :: ScalingParameters
- spDesiredInstanceType :: Lens' ScalingParameters (Maybe PartitionInstanceType)
- spDesiredReplicationCount :: Lens' ScalingParameters (Maybe Natural)
- spDesiredPartitionCount :: Lens' ScalingParameters (Maybe Natural)
- data ScalingParametersStatus
- scalingParametersStatus :: ScalingParameters -> OptionStatus -> ScalingParametersStatus
- spsOptions :: Lens' ScalingParametersStatus ScalingParameters
- spsStatus :: Lens' ScalingParametersStatus OptionStatus
- data ServiceEndpoint
- serviceEndpoint :: ServiceEndpoint
- seEndpoint :: Lens' ServiceEndpoint (Maybe Text)
- data Suggester
- suggester :: Text -> DocumentSuggesterOptions -> Suggester
- sSuggesterName :: Lens' Suggester Text
- sDocumentSuggesterOptions :: Lens' Suggester DocumentSuggesterOptions
- data SuggesterStatus
- suggesterStatus :: Suggester -> OptionStatus -> SuggesterStatus
- ssOptions :: Lens' SuggesterStatus Suggester
- ssStatus :: Lens' SuggesterStatus OptionStatus
- data TextArrayOptions
- textArrayOptions :: TextArrayOptions
- taoSourceFields :: Lens' TextArrayOptions (Maybe Text)
- taoReturnEnabled :: Lens' TextArrayOptions (Maybe Bool)
- taoAnalysisScheme :: Lens' TextArrayOptions (Maybe Text)
- taoHighlightEnabled :: Lens' TextArrayOptions (Maybe Bool)
- taoDefaultValue :: Lens' TextArrayOptions (Maybe Text)
- data TextOptions
- textOptions :: TextOptions
- toSourceField :: Lens' TextOptions (Maybe Text)
- toReturnEnabled :: Lens' TextOptions (Maybe Bool)
- toAnalysisScheme :: Lens' TextOptions (Maybe Text)
- toHighlightEnabled :: Lens' TextOptions (Maybe Bool)
- toSortEnabled :: Lens' TextOptions (Maybe Bool)
- toDefaultValue :: Lens' TextOptions (Maybe Text)
Service Configuration
cloudSearch :: Service Source #
API version '2013-01-01' of the Amazon CloudSearch SDK configuration.
Errors
_BaseException :: AsError a => Getting (First ServiceError) a ServiceError Source #
An error occurred while processing the request.
_DisabledOperationException :: AsError a => Getting (First ServiceError) a ServiceError Source #
The request was rejected because it attempted an operation which is not enabled.
_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 :: AsError a => Getting (First ServiceError) a ServiceError Source #
The request was rejected because it specified an invalid type definition.
_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 :: AsError a => Getting (First ServiceError) a ServiceError Source #
The request was rejected because a resource limit has already been met.
AlgorithmicStemming
data AlgorithmicStemming Source #
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 #
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
Arguments
| :: Text | |
| -> OptionStatus | |
| -> 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
Arguments
| :: Text | |
| -> AnalysisSchemeLanguage | |
| -> 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
Arguments
| :: AnalysisScheme | |
| -> OptionStatus | |
| -> 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 | |
| -> OptionStatus | |
| -> 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.
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 | |
| -> 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.
Arguments
| :: Text | |
| -> Text | |
| -> Bool | |
| -> 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.
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.
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.
Arguments
| :: Text | |
| -> Text | |
| -> 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
Arguments
| :: Expression | |
| -> OptionStatus | |
| -> 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.
Arguments
| :: Text | |
| -> IndexFieldType | |
| -> 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
Arguments
| :: IndexField | |
| -> OptionStatus | |
| -> 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.
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
See: limits smart constructor.
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:
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.
Arguments
| :: UTCTime | |
| -> UTCTime | |
| -> OptionState | |
| -> 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 | |
| -> OptionStatus | |
| -> 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.
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
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.
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:
sDocumentSuggesterOptions :: Lens' Suggester DocumentSuggesterOptions Source #
Undocumented member.
SuggesterStatus
data SuggesterStatus Source #
The value of a Suggester and its current status.
See: suggesterStatus smart constructor.
Arguments
| :: Suggester | |
| -> OptionStatus | |
| -> 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:
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.
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.