-- Hoogle documentation, generated by Haddock
-- See Hoogle, http://www.haskell.org/hoogle/
-- | Amazon CloudSearch SDK.
--
@package amazonka-cloudsearch
@version 1.3.0
module Network.AWS.CloudSearch.Types
-- | API version '2013-01-01' of the Amazon CloudSearch SDK configuration.
cloudSearch :: Service
-- | An error occurred while processing the request.
_BaseException :: AsError a => Getting (First ServiceError) a ServiceError
-- | The request was rejected because it attempted an operation which is
-- not enabled.
_DisabledOperationException :: AsError a => Getting (First ServiceError) a ServiceError
-- | An internal error occurred while processing the request. If this
-- problem persists, report an issue from the Service Health
-- Dashboard.
_InternalException :: AsError a => Getting (First ServiceError) a ServiceError
-- | The request was rejected because it specified an invalid type
-- definition.
_InvalidTypeException :: AsError a => Getting (First ServiceError) a ServiceError
-- | The request was rejected because it attempted to reference a resource
-- that does not exist.
_ResourceNotFoundException :: AsError a => Getting (First ServiceError) a ServiceError
-- | The request was rejected because a resource limit has already been
-- met.
_LimitExceededException :: AsError a => Getting (First ServiceError) a ServiceError
data AlgorithmicStemming
ASFull :: AlgorithmicStemming
ASLight :: AlgorithmicStemming
ASMinimal :: AlgorithmicStemming
ASNone :: AlgorithmicStemming
-- | An IETF RFC 4646 language code or mul for multiple
-- languages.
data AnalysisSchemeLanguage
AR :: AnalysisSchemeLanguage
BG :: AnalysisSchemeLanguage
CA :: AnalysisSchemeLanguage
CS :: AnalysisSchemeLanguage
DA :: AnalysisSchemeLanguage
DE :: AnalysisSchemeLanguage
EL :: AnalysisSchemeLanguage
EN :: AnalysisSchemeLanguage
ES :: AnalysisSchemeLanguage
EU :: AnalysisSchemeLanguage
FA :: AnalysisSchemeLanguage
FI :: AnalysisSchemeLanguage
FR :: AnalysisSchemeLanguage
GA :: AnalysisSchemeLanguage
GL :: AnalysisSchemeLanguage
HE :: AnalysisSchemeLanguage
HI :: AnalysisSchemeLanguage
HU :: AnalysisSchemeLanguage
HY :: AnalysisSchemeLanguage
IT :: AnalysisSchemeLanguage
Id :: AnalysisSchemeLanguage
JA :: AnalysisSchemeLanguage
KO :: AnalysisSchemeLanguage
LV :: AnalysisSchemeLanguage
Mul :: AnalysisSchemeLanguage
NL :: AnalysisSchemeLanguage
NO :: AnalysisSchemeLanguage
PT :: AnalysisSchemeLanguage
RO :: AnalysisSchemeLanguage
RU :: AnalysisSchemeLanguage
SV :: AnalysisSchemeLanguage
TH :: AnalysisSchemeLanguage
TR :: AnalysisSchemeLanguage
ZhHans :: AnalysisSchemeLanguage
ZhHant :: AnalysisSchemeLanguage
-- | 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.
data IndexFieldType
Date :: IndexFieldType
DateArray :: IndexFieldType
Double :: IndexFieldType
DoubleArray :: IndexFieldType
Int :: IndexFieldType
IntArray :: IndexFieldType
Latlon :: IndexFieldType
Literal :: IndexFieldType
LiteralArray :: IndexFieldType
Text :: IndexFieldType
TextArray :: IndexFieldType
-- | 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.
--
data OptionState
Active :: OptionState
FailedToValidate :: OptionState
Processing :: OptionState
RequiresIndexDocuments :: OptionState
-- | The instance type (such as 'search.m1.small') on which an index
-- partition is hosted.
data PartitionInstanceType
Search_M1_Large :: PartitionInstanceType
Search_M1_Small :: PartitionInstanceType
Search_M2_2XLarge :: PartitionInstanceType
Search_M2_XLarge :: PartitionInstanceType
Search_M3_2XLarge :: PartitionInstanceType
Search_M3_Large :: PartitionInstanceType
Search_M3_Medium :: PartitionInstanceType
Search_M3_XLarge :: PartitionInstanceType
data SuggesterFuzzyMatching
High :: SuggesterFuzzyMatching
Low :: SuggesterFuzzyMatching
None :: SuggesterFuzzyMatching
-- | The configured access rules for the domain's document and search
-- endpoints, and the current status of those rules.
--
-- See: accessPoliciesStatus smart constructor.
data 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:
--
--
accessPoliciesStatus :: Text -> OptionStatus -> AccessPoliciesStatus
-- | Undocumented member.
apsOptions :: Lens' AccessPoliciesStatus Text
-- | Undocumented member.
apsStatus :: Lens' AccessPoliciesStatus OptionStatus
-- | Synonyms, stopwords, and stemming options for an analysis scheme.
-- Includes tokenization dictionary for Japanese.
--
-- See: analysisOptions smart constructor.
data AnalysisOptions
-- | 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:
--
--
analysisOptions :: AnalysisOptions
-- | 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
aoAlgorithmicStemming :: Lens' AnalysisOptions (Maybe AlgorithmicStemming)
-- | 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.
aoStopwords :: Lens' AnalysisOptions (Maybe Text)
-- | 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.
aoJapaneseTokenizationDictionary :: Lens' AnalysisOptions (Maybe Text)
-- | 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.
aoSynonyms :: Lens' AnalysisOptions (Maybe Text)
-- | 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.
aoStemmingDictionary :: Lens' AnalysisOptions (Maybe Text)
-- | 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.
data 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:
--
--
analysisScheme :: Text -> AnalysisSchemeLanguage -> AnalysisScheme
-- | Undocumented member.
asAnalysisOptions :: Lens' AnalysisScheme (Maybe AnalysisOptions)
-- | Undocumented member.
asAnalysisSchemeName :: Lens' AnalysisScheme Text
-- | Undocumented member.
asAnalysisSchemeLanguage :: Lens' AnalysisScheme AnalysisSchemeLanguage
-- | The status and configuration of an AnalysisScheme.
--
-- See: analysisSchemeStatus smart constructor.
data 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:
--
--
analysisSchemeStatus :: AnalysisScheme -> OptionStatus -> AnalysisSchemeStatus
-- | Undocumented member.
assOptions :: Lens' AnalysisSchemeStatus AnalysisScheme
-- | Undocumented member.
assStatus :: Lens' AnalysisSchemeStatus OptionStatus
-- | The status and configuration of the domain's availability options.
--
-- See: availabilityOptionsStatus smart constructor.
data 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:
--
--
availabilityOptionsStatus :: Bool -> OptionStatus -> AvailabilityOptionsStatus
-- | The availability options configured for the domain.
aosOptions :: Lens' AvailabilityOptionsStatus Bool
-- | Undocumented member.
aosStatus :: Lens' AvailabilityOptionsStatus OptionStatus
-- | 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.
data DateArrayOptions
-- | 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:
--
--
dateArrayOptions :: DateArrayOptions
-- | A list of source fields to map to the field.
daosSourceFields :: Lens' DateArrayOptions (Maybe Text)
-- | Whether the contents of the field can be returned in the search
-- results.
daosReturnEnabled :: Lens' DateArrayOptions (Maybe Bool)
-- | Whether facet information can be returned for the field.
daosFacetEnabled :: Lens' DateArrayOptions (Maybe Bool)
-- | Whether the contents of the field are searchable.
daosSearchEnabled :: Lens' DateArrayOptions (Maybe Bool)
-- | A value to use for the field if the field isn't specified for a
-- document.
daosDefaultValue :: Lens' DateArrayOptions (Maybe Text)
-- | 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.
data DateOptions
-- | 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:
--
--
dateOptions :: DateOptions
-- | Undocumented member.
doSourceField :: Lens' DateOptions (Maybe Text)
-- | Whether the contents of the field can be returned in the search
-- results.
doReturnEnabled :: Lens' DateOptions (Maybe Bool)
-- | Whether facet information can be returned for the field.
doFacetEnabled :: Lens' DateOptions (Maybe Bool)
-- | Whether the contents of the field are searchable.
doSearchEnabled :: Lens' DateOptions (Maybe Bool)
-- | Whether the field can be used to sort the search results.
doSortEnabled :: Lens' DateOptions (Maybe Bool)
-- | A value to use for the field if the field isn't specified for a
-- document.
doDefaultValue :: Lens' DateOptions (Maybe Text)
-- | Options for a search suggester.
--
-- See: documentSuggesterOptions smart constructor.
data 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:
--
--
documentSuggesterOptions :: Text -> DocumentSuggesterOptions
-- | 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.
dsoSortExpression :: Lens' DocumentSuggesterOptions (Maybe Text)
-- | 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.
dsoFuzzyMatching :: Lens' DocumentSuggesterOptions (Maybe SuggesterFuzzyMatching)
-- | The name of the index field you want to use for suggestions.
dsoSourceField :: Lens' DocumentSuggesterOptions Text
-- | The current status of the search domain.
--
-- See: domainStatus smart constructor.
data 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:
--
--
domainStatus :: Text -> Text -> Bool -> DomainStatus
-- | The number of search instances that are available to process search
-- requests.
dsSearchInstanceCount :: Lens' DomainStatus (Maybe Natural)
-- | The instance type that is being used to process search requests.
dsSearchInstanceType :: Lens' DomainStatus (Maybe Text)
-- | The service endpoint for updating documents in a search domain.
dsDocService :: Lens' DomainStatus (Maybe ServiceEndpoint)
-- | Undocumented member.
dsARN :: Lens' DomainStatus (Maybe Text)
-- | 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.
dsCreated :: Lens' DomainStatus (Maybe Bool)
-- | The service endpoint for requesting search results from a search
-- domain.
dsSearchService :: Lens' DomainStatus (Maybe ServiceEndpoint)
-- | Undocumented member.
dsLimits :: Lens' DomainStatus (Maybe Limits)
-- | The number of partitions across which the search index is spread.
dsSearchPartitionCount :: Lens' DomainStatus (Maybe Natural)
-- | 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.
dsDeleted :: Lens' DomainStatus (Maybe Bool)
-- | True if processing is being done to activate the current domain
-- configuration.
dsProcessing :: Lens' DomainStatus (Maybe Bool)
-- | Undocumented member.
dsDomainId :: Lens' DomainStatus Text
-- | Undocumented member.
dsDomainName :: Lens' DomainStatus Text
-- | True if IndexDocuments needs to be called to activate the current
-- domain configuration.
dsRequiresIndexDocuments :: Lens' DomainStatus Bool
-- | 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.
data DoubleArrayOptions
-- | 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:
--
--
doubleArrayOptions :: DoubleArrayOptions
-- | A list of source fields to map to the field.
daoSourceFields :: Lens' DoubleArrayOptions (Maybe Text)
-- | Whether the contents of the field can be returned in the search
-- results.
daoReturnEnabled :: Lens' DoubleArrayOptions (Maybe Bool)
-- | Whether facet information can be returned for the field.
daoFacetEnabled :: Lens' DoubleArrayOptions (Maybe Bool)
-- | Whether the contents of the field are searchable.
daoSearchEnabled :: Lens' DoubleArrayOptions (Maybe Bool)
-- | A value to use for the field if the field isn't specified for a
-- document.
daoDefaultValue :: Lens' DoubleArrayOptions (Maybe Double)
-- | 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.
data DoubleOptions
-- | 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:
--
--
doubleOptions :: DoubleOptions
-- | The name of the source field to map to the field.
dSourceField :: Lens' DoubleOptions (Maybe Text)
-- | Whether the contents of the field can be returned in the search
-- results.
dReturnEnabled :: Lens' DoubleOptions (Maybe Bool)
-- | Whether facet information can be returned for the field.
dFacetEnabled :: Lens' DoubleOptions (Maybe Bool)
-- | Whether the contents of the field are searchable.
dSearchEnabled :: Lens' DoubleOptions (Maybe Bool)
-- | Whether the field can be used to sort the search results.
dSortEnabled :: Lens' DoubleOptions (Maybe Bool)
-- | 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.
dDefaultValue :: Lens' DoubleOptions (Maybe Double)
-- | 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.
data 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:
--
--
expression :: Text -> Text -> Expression
-- | Undocumented member.
eExpressionName :: Lens' Expression Text
-- | Undocumented member.
eExpressionValue :: Lens' Expression Text
-- | The value of an Expression and its current status.
--
-- See: expressionStatus smart constructor.
data 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:
--
--
expressionStatus :: Expression -> OptionStatus -> ExpressionStatus
-- | The expression that is evaluated for sorting while processing a search
-- request.
esOptions :: Lens' ExpressionStatus Expression
-- | Undocumented member.
esStatus :: Lens' ExpressionStatus OptionStatus
-- | 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.
data 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:
--
--
indexField :: Text -> IndexFieldType -> IndexField
-- | Undocumented member.
ifDoubleArrayOptions :: Lens' IndexField (Maybe DoubleArrayOptions)
-- | Undocumented member.
ifDateOptions :: Lens' IndexField (Maybe DateOptions)
-- | Undocumented member.
ifTextArrayOptions :: Lens' IndexField (Maybe TextArrayOptions)
-- | Undocumented member.
ifDoubleOptions :: Lens' IndexField (Maybe DoubleOptions)
-- | Undocumented member.
ifTextOptions :: Lens' IndexField (Maybe TextOptions)
-- | Undocumented member.
ifLatLonOptions :: Lens' IndexField (Maybe LatLonOptions)
-- | Undocumented member.
ifLiteralArrayOptions :: Lens' IndexField (Maybe LiteralArrayOptions)
-- | Undocumented member.
ifIntArrayOptions :: Lens' IndexField (Maybe IntArrayOptions)
-- | Undocumented member.
ifDateArrayOptions :: Lens' IndexField (Maybe DateArrayOptions)
-- | Undocumented member.
ifIntOptions :: Lens' IndexField (Maybe IntOptions)
-- | Undocumented member.
ifLiteralOptions :: Lens' IndexField (Maybe LiteralOptions)
-- | 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.
ifIndexFieldName :: Lens' IndexField Text
-- | Undocumented member.
ifIndexFieldType :: Lens' IndexField IndexFieldType
-- | The value of an IndexField and its current status.
--
-- See: indexFieldStatus smart constructor.
data 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:
--
--
indexFieldStatus :: IndexField -> OptionStatus -> IndexFieldStatus
-- | Undocumented member.
ifsOptions :: Lens' IndexFieldStatus IndexField
-- | Undocumented member.
ifsStatus :: Lens' IndexFieldStatus OptionStatus
-- | 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.
data IntArrayOptions
-- | 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:
--
--
intArrayOptions :: IntArrayOptions
-- | A list of source fields to map to the field.
iaoSourceFields :: Lens' IntArrayOptions (Maybe Text)
-- | Whether the contents of the field can be returned in the search
-- results.
iaoReturnEnabled :: Lens' IntArrayOptions (Maybe Bool)
-- | Whether facet information can be returned for the field.
iaoFacetEnabled :: Lens' IntArrayOptions (Maybe Bool)
-- | Whether the contents of the field are searchable.
iaoSearchEnabled :: Lens' IntArrayOptions (Maybe Bool)
-- | A value to use for the field if the field isn't specified for a
-- document.
iaoDefaultValue :: Lens' IntArrayOptions (Maybe Integer)
-- | 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.
data IntOptions
-- | 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:
--
--
intOptions :: IntOptions
-- | The name of the source field to map to the field.
ioSourceField :: Lens' IntOptions (Maybe Text)
-- | Whether the contents of the field can be returned in the search
-- results.
ioReturnEnabled :: Lens' IntOptions (Maybe Bool)
-- | Whether facet information can be returned for the field.
ioFacetEnabled :: Lens' IntOptions (Maybe Bool)
-- | Whether the contents of the field are searchable.
ioSearchEnabled :: Lens' IntOptions (Maybe Bool)
-- | Whether the field can be used to sort the search results.
ioSortEnabled :: Lens' IntOptions (Maybe Bool)
-- | 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.
ioDefaultValue :: Lens' IntOptions (Maybe Integer)
-- | 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.
data LatLonOptions
-- | 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:
--
--
latLonOptions :: LatLonOptions
-- | Undocumented member.
lloSourceField :: Lens' LatLonOptions (Maybe Text)
-- | Whether the contents of the field can be returned in the search
-- results.
lloReturnEnabled :: Lens' LatLonOptions (Maybe Bool)
-- | Whether facet information can be returned for the field.
lloFacetEnabled :: Lens' LatLonOptions (Maybe Bool)
-- | Whether the contents of the field are searchable.
lloSearchEnabled :: Lens' LatLonOptions (Maybe Bool)
-- | Whether the field can be used to sort the search results.
lloSortEnabled :: Lens' LatLonOptions (Maybe Bool)
-- | A value to use for the field if the field isn't specified for a
-- document.
lloDefaultValue :: Lens' LatLonOptions (Maybe Text)
-- | See: limits smart constructor.
data 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:
--
--
limits :: Natural -> Natural -> Limits
-- | Undocumented member.
lMaximumReplicationCount :: Lens' Limits Natural
-- | Undocumented member.
lMaximumPartitionCount :: Lens' Limits Natural
-- | 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.
data LiteralArrayOptions
-- | 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:
--
--
literalArrayOptions :: LiteralArrayOptions
-- | A list of source fields to map to the field.
laoSourceFields :: Lens' LiteralArrayOptions (Maybe Text)
-- | Whether the contents of the field can be returned in the search
-- results.
laoReturnEnabled :: Lens' LiteralArrayOptions (Maybe Bool)
-- | Whether facet information can be returned for the field.
laoFacetEnabled :: Lens' LiteralArrayOptions (Maybe Bool)
-- | Whether the contents of the field are searchable.
laoSearchEnabled :: Lens' LiteralArrayOptions (Maybe Bool)
-- | A value to use for the field if the field isn't specified for a
-- document.
laoDefaultValue :: Lens' LiteralArrayOptions (Maybe Text)
-- | Options for literal field. Present if IndexFieldType specifies
-- the field is of type literal. All options are enabled by
-- default.
--
-- See: literalOptions smart constructor.
data LiteralOptions
-- | 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:
--
--
literalOptions :: LiteralOptions
-- | Undocumented member.
loSourceField :: Lens' LiteralOptions (Maybe Text)
-- | Whether the contents of the field can be returned in the search
-- results.
loReturnEnabled :: Lens' LiteralOptions (Maybe Bool)
-- | Whether facet information can be returned for the field.
loFacetEnabled :: Lens' LiteralOptions (Maybe Bool)
-- | Whether the contents of the field are searchable.
loSearchEnabled :: Lens' LiteralOptions (Maybe Bool)
-- | Whether the field can be used to sort the search results.
loSortEnabled :: Lens' LiteralOptions (Maybe Bool)
-- | A value to use for the field if the field isn't specified for a
-- document.
loDefaultValue :: Lens' LiteralOptions (Maybe Text)
-- | The status of domain configuration option.
--
-- See: optionStatus smart constructor.
data 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:
--
--
optionStatus :: UTCTime -> UTCTime -> OptionState -> OptionStatus
-- | Indicates that the option will be deleted once processing is complete.
osPendingDeletion :: Lens' OptionStatus (Maybe Bool)
-- | A unique integer that indicates when this option was last updated.
osUpdateVersion :: Lens' OptionStatus (Maybe Natural)
-- | A timestamp for when this option was created.
osCreationDate :: Lens' OptionStatus UTCTime
-- | A timestamp for when this option was last updated.
osUpdateDate :: Lens' OptionStatus UTCTime
-- | 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.
--
osState :: Lens' OptionStatus OptionState
-- | The desired instance type and desired number of replicas of each index
-- partition.
--
-- See: scalingParameters smart constructor.
data ScalingParameters
-- | 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:
--
--
scalingParameters :: ScalingParameters
-- | The instance type that you want to preconfigure for your domain. For
-- example, 'search.m1.small'.
spDesiredInstanceType :: Lens' ScalingParameters (Maybe PartitionInstanceType)
-- | The number of replicas you want to preconfigure for each index
-- partition.
spDesiredReplicationCount :: Lens' ScalingParameters (Maybe Natural)
-- | The number of partitions you want to preconfigure for your domain.
-- Only valid when you select 'm2.2xlarge' as the desired instance type.
spDesiredPartitionCount :: Lens' ScalingParameters (Maybe Natural)
-- | The status and configuration of a search domain's scaling parameters.
--
-- See: scalingParametersStatus smart constructor.
data 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:
--
--
scalingParametersStatus :: ScalingParameters -> OptionStatus -> ScalingParametersStatus
-- | Undocumented member.
spsOptions :: Lens' ScalingParametersStatus ScalingParameters
-- | Undocumented member.
spsStatus :: Lens' ScalingParametersStatus OptionStatus
-- | The endpoint to which service requests can be submitted.
--
-- See: serviceEndpoint smart constructor.
data ServiceEndpoint
-- | 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:
--
--
serviceEndpoint :: ServiceEndpoint
-- | Undocumented member.
seEndpoint :: Lens' ServiceEndpoint (Maybe Text)
-- | 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.
data 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:
--
--
suggester :: Text -> DocumentSuggesterOptions -> Suggester
-- | Undocumented member.
sSuggesterName :: Lens' Suggester Text
-- | Undocumented member.
sDocumentSuggesterOptions :: Lens' Suggester DocumentSuggesterOptions
-- | The value of a Suggester and its current status.
--
-- See: suggesterStatus smart constructor.
data 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:
--
--
suggesterStatus :: Suggester -> OptionStatus -> SuggesterStatus
-- | Undocumented member.
ssOptions :: Lens' SuggesterStatus Suggester
-- | Undocumented member.
ssStatus :: Lens' SuggesterStatus OptionStatus
-- | 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.
data TextArrayOptions
-- | 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:
--
--
textArrayOptions :: TextArrayOptions
-- | A list of source fields to map to the field.
taoSourceFields :: Lens' TextArrayOptions (Maybe Text)
-- | Whether the contents of the field can be returned in the search
-- results.
taoReturnEnabled :: Lens' TextArrayOptions (Maybe Bool)
-- | The name of an analysis scheme for a 'text-array' field.
taoAnalysisScheme :: Lens' TextArrayOptions (Maybe Text)
-- | Whether highlights can be returned for the field.
taoHighlightEnabled :: Lens' TextArrayOptions (Maybe Bool)
-- | A value to use for the field if the field isn't specified for a
-- document.
taoDefaultValue :: Lens' TextArrayOptions (Maybe Text)
-- | 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.
data TextOptions
-- | 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:
--
--
textOptions :: TextOptions
-- | Undocumented member.
toSourceField :: Lens' TextOptions (Maybe Text)
-- | Whether the contents of the field can be returned in the search
-- results.
toReturnEnabled :: Lens' TextOptions (Maybe Bool)
-- | The name of an analysis scheme for a text field.
toAnalysisScheme :: Lens' TextOptions (Maybe Text)
-- | Whether highlights can be returned for the field.
toHighlightEnabled :: Lens' TextOptions (Maybe Bool)
-- | Whether the field can be used to sort the search results.
toSortEnabled :: Lens' TextOptions (Maybe Bool)
-- | A value to use for the field if the field isn't specified for a
-- document.
toDefaultValue :: Lens' TextOptions (Maybe Text)
module Network.AWS.CloudSearch.Waiters
-- | Configures an IndexField for the search domain. Used to create
-- new fields and modify existing ones. You must specify the name of the
-- domain you are configuring and an index field configuration. The index
-- field configuration specifies a unique name, the index field type, and
-- the options you want to configure for the field. The options you can
-- specify depend on the IndexFieldType. If the field exists, the
-- new configuration replaces the old one. For more information, see
-- Configuring Index Fields in the Amazon CloudSearch Developer
-- Guide.
--
-- See: AWS API Reference for DefineIndexField.
module Network.AWS.CloudSearch.DefineIndexField
-- | Creates a value of DefineIndexField with the minimum fields
-- required to make a request.
--
-- Use one of the following lenses to modify other fields as desired:
--
--
defineIndexField :: Text -> IndexField -> DefineIndexField
-- | Container for the parameters to the DefineIndexField operation.
-- Specifies the name of the domain you want to update and the index
-- field configuration.
--
-- See: defineIndexField smart constructor.
data DefineIndexField
-- | Undocumented member.
defeDomainName :: Lens' DefineIndexField Text
-- | The index field and field options you want to configure.
defeIndexField :: Lens' DefineIndexField IndexField
-- | Creates a value of DefineIndexFieldResponse with the minimum
-- fields required to make a request.
--
-- Use one of the following lenses to modify other fields as desired:
--
--
defineIndexFieldResponse :: Int -> IndexFieldStatus -> DefineIndexFieldResponse
-- | The result of a DefineIndexField request. Contains the status
-- of the newly-configured index field.
--
-- See: defineIndexFieldResponse smart constructor.
data DefineIndexFieldResponse
-- | The response status code.
defrsResponseStatus :: Lens' DefineIndexFieldResponse Int
-- | Undocumented member.
defrsIndexField :: Lens' DefineIndexFieldResponse IndexFieldStatus
instance Typeable DefineIndexField
instance Typeable DefineIndexFieldResponse
instance Eq DefineIndexField
instance Read DefineIndexField
instance Show DefineIndexField
instance Data DefineIndexField
instance Generic DefineIndexField
instance Eq DefineIndexFieldResponse
instance Read DefineIndexFieldResponse
instance Show DefineIndexFieldResponse
instance Data DefineIndexFieldResponse
instance Generic DefineIndexFieldResponse
instance Datatype D1DefineIndexField
instance Constructor C1_0DefineIndexField
instance Selector S1_0_0DefineIndexField
instance Selector S1_0_1DefineIndexField
instance Datatype D1DefineIndexFieldResponse
instance Constructor C1_0DefineIndexFieldResponse
instance Selector S1_0_0DefineIndexFieldResponse
instance Selector S1_0_1DefineIndexFieldResponse
instance ToQuery DefineIndexField
instance ToPath DefineIndexField
instance ToHeaders DefineIndexField
instance AWSRequest DefineIndexField
-- | Permanently deletes a search domain and all of its data. Once a domain
-- has been deleted, it cannot be recovered. For more information, see
-- Deleting a Search Domain in the Amazon CloudSearch Developer
-- Guide.
--
-- See: AWS API Reference for DeleteDomain.
module Network.AWS.CloudSearch.DeleteDomain
-- | Creates a value of DeleteDomain with the minimum fields
-- required to make a request.
--
-- Use one of the following lenses to modify other fields as desired:
--
--
deleteDomain :: Text -> DeleteDomain
-- | Container for the parameters to the DeleteDomain operation.
-- Specifies the name of the domain you want to delete.
--
-- See: deleteDomain smart constructor.
data DeleteDomain
-- | The name of the domain you want to permanently delete.
dddDomainName :: Lens' DeleteDomain Text
-- | Creates a value of DeleteDomainResponse with the minimum fields
-- required to make a request.
--
-- Use one of the following lenses to modify other fields as desired:
--
--
deleteDomainResponse :: Int -> DeleteDomainResponse
-- | 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.
--
-- See: deleteDomainResponse smart constructor.
data DeleteDomainResponse
-- | Undocumented member.
ddrsDomainStatus :: Lens' DeleteDomainResponse (Maybe DomainStatus)
-- | The response status code.
ddrsResponseStatus :: Lens' DeleteDomainResponse Int
instance Typeable DeleteDomain
instance Typeable DeleteDomainResponse
instance Eq DeleteDomain
instance Read DeleteDomain
instance Show DeleteDomain
instance Data DeleteDomain
instance Generic DeleteDomain
instance Eq DeleteDomainResponse
instance Read DeleteDomainResponse
instance Show DeleteDomainResponse
instance Data DeleteDomainResponse
instance Generic DeleteDomainResponse
instance Datatype D1DeleteDomain
instance Constructor C1_0DeleteDomain
instance Selector S1_0_0DeleteDomain
instance Datatype D1DeleteDomainResponse
instance Constructor C1_0DeleteDomainResponse
instance Selector S1_0_0DeleteDomainResponse
instance Selector S1_0_1DeleteDomainResponse
instance ToQuery DeleteDomain
instance ToPath DeleteDomain
instance ToHeaders DeleteDomain
instance AWSRequest DeleteDomain
-- | Indexes the search suggestions. For more information, see
-- Configuring Suggesters in the Amazon CloudSearch Developer
-- Guide.
--
-- See: AWS API Reference for BuildSuggesters.
module Network.AWS.CloudSearch.BuildSuggesters
-- | Creates a value of BuildSuggesters with the minimum fields
-- required to make a request.
--
-- Use one of the following lenses to modify other fields as desired:
--
--
buildSuggesters :: Text -> BuildSuggesters
-- | Container for the parameters to the BuildSuggester operation.
-- Specifies the name of the domain you want to update.
--
-- See: buildSuggesters smart constructor.
data BuildSuggesters
-- | Undocumented member.
bsDomainName :: Lens' BuildSuggesters Text
-- | Creates a value of BuildSuggestersResponse with the minimum
-- fields required to make a request.
--
-- Use one of the following lenses to modify other fields as desired:
--
--
buildSuggestersResponse :: Int -> BuildSuggestersResponse
-- | The result of a BuildSuggester request. Contains a list of
-- the fields used for suggestions.
--
-- See: buildSuggestersResponse smart constructor.
data BuildSuggestersResponse
-- | Undocumented member.
bsrsFieldNames :: Lens' BuildSuggestersResponse [Text]
-- | The response status code.
bsrsResponseStatus :: Lens' BuildSuggestersResponse Int
instance Typeable BuildSuggesters
instance Typeable BuildSuggestersResponse
instance Eq BuildSuggesters
instance Read BuildSuggesters
instance Show BuildSuggesters
instance Data BuildSuggesters
instance Generic BuildSuggesters
instance Eq BuildSuggestersResponse
instance Read BuildSuggestersResponse
instance Show BuildSuggestersResponse
instance Data BuildSuggestersResponse
instance Generic BuildSuggestersResponse
instance Datatype D1BuildSuggesters
instance Constructor C1_0BuildSuggesters
instance Selector S1_0_0BuildSuggesters
instance Datatype D1BuildSuggestersResponse
instance Constructor C1_0BuildSuggestersResponse
instance Selector S1_0_0BuildSuggestersResponse
instance Selector S1_0_1BuildSuggestersResponse
instance ToQuery BuildSuggesters
instance ToPath BuildSuggesters
instance ToHeaders BuildSuggesters
instance AWSRequest BuildSuggesters
-- | Configures scaling parameters for a domain. A domain's scaling
-- parameters specify the desired search instance type and replication
-- count. Amazon CloudSearch will still automatically scale your domain
-- based on the volume of data and traffic, but not below the desired
-- instance type and replication count. If the Multi-AZ option is
-- enabled, these values control the resources used per Availability
-- Zone. For more information, see Configuring Scaling Options in
-- the Amazon CloudSearch Developer Guide.
--
-- See: AWS API Reference for UpdateScalingParameters.
module Network.AWS.CloudSearch.UpdateScalingParameters
-- | Creates a value of UpdateScalingParameters with the minimum
-- fields required to make a request.
--
-- Use one of the following lenses to modify other fields as desired:
--
--
updateScalingParameters :: Text -> ScalingParameters -> UpdateScalingParameters
-- | 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.
--
-- See: updateScalingParameters smart constructor.
data UpdateScalingParameters
-- | Undocumented member.
uspDomainName :: Lens' UpdateScalingParameters Text
-- | Undocumented member.
uspScalingParameters :: Lens' UpdateScalingParameters ScalingParameters
-- | Creates a value of UpdateScalingParametersResponse with the
-- minimum fields required to make a request.
--
-- Use one of the following lenses to modify other fields as desired:
--
--
updateScalingParametersResponse :: Int -> ScalingParametersStatus -> UpdateScalingParametersResponse
-- | The result of a UpdateScalingParameters request. Contains the
-- status of the newly-configured scaling parameters.
--
-- See: updateScalingParametersResponse smart constructor.
data UpdateScalingParametersResponse
-- | The response status code.
usprsResponseStatus :: Lens' UpdateScalingParametersResponse Int
-- | Undocumented member.
usprsScalingParameters :: Lens' UpdateScalingParametersResponse ScalingParametersStatus
instance Typeable UpdateScalingParameters
instance Typeable UpdateScalingParametersResponse
instance Eq UpdateScalingParameters
instance Read UpdateScalingParameters
instance Show UpdateScalingParameters
instance Data UpdateScalingParameters
instance Generic UpdateScalingParameters
instance Eq UpdateScalingParametersResponse
instance Read UpdateScalingParametersResponse
instance Show UpdateScalingParametersResponse
instance Data UpdateScalingParametersResponse
instance Generic UpdateScalingParametersResponse
instance Datatype D1UpdateScalingParameters
instance Constructor C1_0UpdateScalingParameters
instance Selector S1_0_0UpdateScalingParameters
instance Selector S1_0_1UpdateScalingParameters
instance Datatype D1UpdateScalingParametersResponse
instance Constructor C1_0UpdateScalingParametersResponse
instance Selector S1_0_0UpdateScalingParametersResponse
instance Selector S1_0_1UpdateScalingParametersResponse
instance ToQuery UpdateScalingParameters
instance ToPath UpdateScalingParameters
instance ToHeaders UpdateScalingParameters
instance AWSRequest UpdateScalingParameters
-- | Configures the access rules that control access to the domain's
-- document and search endpoints. For more information, see
-- Configuring Access for an Amazon CloudSearch Domain.
--
-- See: AWS API Reference for UpdateServiceAccessPolicies.
module Network.AWS.CloudSearch.UpdateServiceAccessPolicies
-- | Creates a value of UpdateServiceAccessPolicies with the minimum
-- fields required to make a request.
--
-- Use one of the following lenses to modify other fields as desired:
--
--
updateServiceAccessPolicies :: Text -> Text -> UpdateServiceAccessPolicies
-- | 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.
--
-- See: updateServiceAccessPolicies smart constructor.
data UpdateServiceAccessPolicies
-- | Undocumented member.
usapDomainName :: Lens' UpdateServiceAccessPolicies Text
-- | The access rules you want to configure. These rules replace any
-- existing rules.
usapAccessPolicies :: Lens' UpdateServiceAccessPolicies Text
-- | Creates a value of UpdateServiceAccessPoliciesResponse with the
-- minimum fields required to make a request.
--
-- Use one of the following lenses to modify other fields as desired:
--
--
updateServiceAccessPoliciesResponse :: Int -> AccessPoliciesStatus -> UpdateServiceAccessPoliciesResponse
-- | The result of an UpdateServiceAccessPolicies request. Contains
-- the new access policies.
--
-- See: updateServiceAccessPoliciesResponse smart
-- constructor.
data UpdateServiceAccessPoliciesResponse
-- | The response status code.
usaprsResponseStatus :: Lens' UpdateServiceAccessPoliciesResponse Int
-- | The access rules configured for the domain.
usaprsAccessPolicies :: Lens' UpdateServiceAccessPoliciesResponse AccessPoliciesStatus
instance Typeable UpdateServiceAccessPolicies
instance Typeable UpdateServiceAccessPoliciesResponse
instance Eq UpdateServiceAccessPolicies
instance Read UpdateServiceAccessPolicies
instance Show UpdateServiceAccessPolicies
instance Data UpdateServiceAccessPolicies
instance Generic UpdateServiceAccessPolicies
instance Eq UpdateServiceAccessPoliciesResponse
instance Read UpdateServiceAccessPoliciesResponse
instance Show UpdateServiceAccessPoliciesResponse
instance Data UpdateServiceAccessPoliciesResponse
instance Generic UpdateServiceAccessPoliciesResponse
instance Datatype D1UpdateServiceAccessPolicies
instance Constructor C1_0UpdateServiceAccessPolicies
instance Selector S1_0_0UpdateServiceAccessPolicies
instance Selector S1_0_1UpdateServiceAccessPolicies
instance Datatype D1UpdateServiceAccessPoliciesResponse
instance Constructor C1_0UpdateServiceAccessPoliciesResponse
instance Selector S1_0_0UpdateServiceAccessPoliciesResponse
instance Selector S1_0_1UpdateServiceAccessPoliciesResponse
instance ToQuery UpdateServiceAccessPolicies
instance ToPath UpdateServiceAccessPolicies
instance ToHeaders UpdateServiceAccessPolicies
instance AWSRequest UpdateServiceAccessPolicies
-- | Removes an IndexField from the search domain. For more
-- information, see Configuring Index Fields in the Amazon
-- CloudSearch Developer Guide.
--
-- See: AWS API Reference for DeleteIndexField.
module Network.AWS.CloudSearch.DeleteIndexField
-- | Creates a value of DeleteIndexField with the minimum fields
-- required to make a request.
--
-- Use one of the following lenses to modify other fields as desired:
--
--
deleteIndexField :: Text -> Text -> DeleteIndexField
-- | 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.
--
-- See: deleteIndexField smart constructor.
data DeleteIndexField
-- | Undocumented member.
difiDomainName :: Lens' DeleteIndexField Text
-- | The name of the index field your want to remove from the domain's
-- indexing options.
difiIndexFieldName :: Lens' DeleteIndexField Text
-- | Creates a value of DeleteIndexFieldResponse with the minimum
-- fields required to make a request.
--
-- Use one of the following lenses to modify other fields as desired:
--
--
deleteIndexFieldResponse :: Int -> IndexFieldStatus -> DeleteIndexFieldResponse
-- | The result of a DeleteIndexField request.
--
-- See: deleteIndexFieldResponse smart constructor.
data DeleteIndexFieldResponse
-- | The response status code.
difrsResponseStatus :: Lens' DeleteIndexFieldResponse Int
-- | The status of the index field being deleted.
difrsIndexField :: Lens' DeleteIndexFieldResponse IndexFieldStatus
instance Typeable DeleteIndexField
instance Typeable DeleteIndexFieldResponse
instance Eq DeleteIndexField
instance Read DeleteIndexField
instance Show DeleteIndexField
instance Data DeleteIndexField
instance Generic DeleteIndexField
instance Eq DeleteIndexFieldResponse
instance Read DeleteIndexFieldResponse
instance Show DeleteIndexFieldResponse
instance Data DeleteIndexFieldResponse
instance Generic DeleteIndexFieldResponse
instance Datatype D1DeleteIndexField
instance Constructor C1_0DeleteIndexField
instance Selector S1_0_0DeleteIndexField
instance Selector S1_0_1DeleteIndexField
instance Datatype D1DeleteIndexFieldResponse
instance Constructor C1_0DeleteIndexFieldResponse
instance Selector S1_0_0DeleteIndexFieldResponse
instance Selector S1_0_1DeleteIndexFieldResponse
instance ToQuery DeleteIndexField
instance ToPath DeleteIndexField
instance ToHeaders DeleteIndexField
instance AWSRequest DeleteIndexField
-- | Tells the search domain to start indexing its documents using the
-- latest indexing options. This operation must be invoked to activate
-- options whose OptionStatus is RequiresIndexDocuments.
--
-- See: AWS API Reference for IndexDocuments.
module Network.AWS.CloudSearch.IndexDocuments
-- | Creates a value of IndexDocuments with the minimum fields
-- required to make a request.
--
-- Use one of the following lenses to modify other fields as desired:
--
--
indexDocuments :: Text -> IndexDocuments
-- | Container for the parameters to the IndexDocuments operation.
-- Specifies the name of the domain you want to re-index.
--
-- See: indexDocuments smart constructor.
data IndexDocuments
-- | Undocumented member.
idDomainName :: Lens' IndexDocuments Text
-- | Creates a value of IndexDocumentsResponse with the minimum
-- fields required to make a request.
--
-- Use one of the following lenses to modify other fields as desired:
--
--
indexDocumentsResponse :: Int -> IndexDocumentsResponse
-- | The result of an IndexDocuments request. Contains the status of
-- the indexing operation, including the fields being indexed.
--
-- See: indexDocumentsResponse smart constructor.
data IndexDocumentsResponse
-- | The names of the fields that are currently being indexed.
idrsFieldNames :: Lens' IndexDocumentsResponse [Text]
-- | The response status code.
idrsResponseStatus :: Lens' IndexDocumentsResponse Int
instance Typeable IndexDocuments
instance Typeable IndexDocumentsResponse
instance Eq IndexDocuments
instance Read IndexDocuments
instance Show IndexDocuments
instance Data IndexDocuments
instance Generic IndexDocuments
instance Eq IndexDocumentsResponse
instance Read IndexDocumentsResponse
instance Show IndexDocumentsResponse
instance Data IndexDocumentsResponse
instance Generic IndexDocumentsResponse
instance Datatype D1IndexDocuments
instance Constructor C1_0IndexDocuments
instance Selector S1_0_0IndexDocuments
instance Datatype D1IndexDocumentsResponse
instance Constructor C1_0IndexDocumentsResponse
instance Selector S1_0_0IndexDocumentsResponse
instance Selector S1_0_1IndexDocumentsResponse
instance ToQuery IndexDocuments
instance ToPath IndexDocuments
instance ToHeaders IndexDocuments
instance AWSRequest IndexDocuments
-- | Configures an analysis scheme that can be applied to a text
-- or 'text-array' field to define language-specific text processing
-- options. For more information, see Configuring Analysis Schemes
-- in the Amazon CloudSearch Developer Guide.
--
-- See: AWS API Reference for DefineAnalysisScheme.
module Network.AWS.CloudSearch.DefineAnalysisScheme
-- | Creates a value of DefineAnalysisScheme with the minimum fields
-- required to make a request.
--
-- Use one of the following lenses to modify other fields as desired:
--
--
defineAnalysisScheme :: Text -> AnalysisScheme -> DefineAnalysisScheme
-- | Container for the parameters to the DefineAnalysisScheme
-- operation. Specifies the name of the domain you want to update and the
-- analysis scheme configuration.
--
-- See: defineAnalysisScheme smart constructor.
data DefineAnalysisScheme
-- | Undocumented member.
dasaDomainName :: Lens' DefineAnalysisScheme Text
-- | Undocumented member.
dasaAnalysisScheme :: Lens' DefineAnalysisScheme AnalysisScheme
-- | Creates a value of DefineAnalysisSchemeResponse with the
-- minimum fields required to make a request.
--
-- Use one of the following lenses to modify other fields as desired:
--
--
defineAnalysisSchemeResponse :: Int -> AnalysisSchemeStatus -> DefineAnalysisSchemeResponse
-- | The result of a DefineAnalysisScheme request. Contains the
-- status of the newly-configured analysis scheme.
--
-- See: defineAnalysisSchemeResponse smart constructor.
data DefineAnalysisSchemeResponse
-- | The response status code.
defersResponseStatus :: Lens' DefineAnalysisSchemeResponse Int
-- | Undocumented member.
defersAnalysisScheme :: Lens' DefineAnalysisSchemeResponse AnalysisSchemeStatus
instance Typeable DefineAnalysisScheme
instance Typeable DefineAnalysisSchemeResponse
instance Eq DefineAnalysisScheme
instance Read DefineAnalysisScheme
instance Show DefineAnalysisScheme
instance Data DefineAnalysisScheme
instance Generic DefineAnalysisScheme
instance Eq DefineAnalysisSchemeResponse
instance Read DefineAnalysisSchemeResponse
instance Show DefineAnalysisSchemeResponse
instance Data DefineAnalysisSchemeResponse
instance Generic DefineAnalysisSchemeResponse
instance Datatype D1DefineAnalysisScheme
instance Constructor C1_0DefineAnalysisScheme
instance Selector S1_0_0DefineAnalysisScheme
instance Selector S1_0_1DefineAnalysisScheme
instance Datatype D1DefineAnalysisSchemeResponse
instance Constructor C1_0DefineAnalysisSchemeResponse
instance Selector S1_0_0DefineAnalysisSchemeResponse
instance Selector S1_0_1DefineAnalysisSchemeResponse
instance ToQuery DefineAnalysisScheme
instance ToPath DefineAnalysisScheme
instance ToHeaders DefineAnalysisScheme
instance AWSRequest DefineAnalysisScheme
-- | Deletes a suggester. For more information, see Getting Search
-- Suggestions in the Amazon CloudSearch Developer Guide.
--
-- See: AWS API Reference for DeleteSuggester.
module Network.AWS.CloudSearch.DeleteSuggester
-- | Creates a value of DeleteSuggester with the minimum fields
-- required to make a request.
--
-- Use one of the following lenses to modify other fields as desired:
--
--
deleteSuggester :: Text -> Text -> DeleteSuggester
-- | 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.
--
-- See: deleteSuggester smart constructor.
data DeleteSuggester
-- | Undocumented member.
ddDomainName :: Lens' DeleteSuggester Text
-- | Specifies the name of the suggester you want to delete.
ddSuggesterName :: Lens' DeleteSuggester Text
-- | Creates a value of DeleteSuggesterResponse with the minimum
-- fields required to make a request.
--
-- Use one of the following lenses to modify other fields as desired:
--
--
deleteSuggesterResponse :: Int -> SuggesterStatus -> DeleteSuggesterResponse
-- | The result of a DeleteSuggester request. Contains the status of
-- the deleted suggester.
--
-- See: deleteSuggesterResponse smart constructor.
data DeleteSuggesterResponse
-- | The response status code.
delersResponseStatus :: Lens' DeleteSuggesterResponse Int
-- | The status of the suggester being deleted.
delersSuggester :: Lens' DeleteSuggesterResponse SuggesterStatus
instance Typeable DeleteSuggester
instance Typeable DeleteSuggesterResponse
instance Eq DeleteSuggester
instance Read DeleteSuggester
instance Show DeleteSuggester
instance Data DeleteSuggester
instance Generic DeleteSuggester
instance Eq DeleteSuggesterResponse
instance Read DeleteSuggesterResponse
instance Show DeleteSuggesterResponse
instance Data DeleteSuggesterResponse
instance Generic DeleteSuggesterResponse
instance Datatype D1DeleteSuggester
instance Constructor C1_0DeleteSuggester
instance Selector S1_0_0DeleteSuggester
instance Selector S1_0_1DeleteSuggester
instance Datatype D1DeleteSuggesterResponse
instance Constructor C1_0DeleteSuggesterResponse
instance Selector S1_0_0DeleteSuggesterResponse
instance Selector S1_0_1DeleteSuggesterResponse
instance ToQuery DeleteSuggester
instance ToPath DeleteSuggester
instance ToHeaders DeleteSuggester
instance AWSRequest DeleteSuggester
-- | Gets information about the index fields configured for the search
-- domain. Can be limited to specific fields by name. By default, shows
-- all fields and includes any pending changes to the configuration. Set
-- the Deployed option to true to show the active
-- configuration and exclude pending changes. For more information, see
-- Getting Domain Information in the Amazon CloudSearch
-- Developer Guide.
--
-- See: AWS API Reference for DescribeIndexFields.
module Network.AWS.CloudSearch.DescribeIndexFields
-- | Creates a value of DescribeIndexFields with the minimum fields
-- required to make a request.
--
-- Use one of the following lenses to modify other fields as desired:
--
--
describeIndexFields :: Text -> DescribeIndexFields
-- | 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.
--
-- See: describeIndexFields smart constructor.
data DescribeIndexFields
-- | Whether to display the deployed configuration (true) or
-- include any pending changes (false). Defaults to
-- false.
difDeployed :: Lens' DescribeIndexFields (Maybe Bool)
-- | A list of the index fields you want to describe. If not specified,
-- information is returned for all configured index fields.
difFieldNames :: Lens' DescribeIndexFields [Text]
-- | The name of the domain you want to describe.
difDomainName :: Lens' DescribeIndexFields Text
-- | Creates a value of DescribeIndexFieldsResponse with the minimum
-- fields required to make a request.
--
-- Use one of the following lenses to modify other fields as desired:
--
--
describeIndexFieldsResponse :: Int -> DescribeIndexFieldsResponse
-- | The result of a DescribeIndexFields request. Contains the index
-- fields configured for the domain specified in the request.
--
-- See: describeIndexFieldsResponse smart constructor.
data DescribeIndexFieldsResponse
-- | The response status code.
difsrsResponseStatus :: Lens' DescribeIndexFieldsResponse Int
-- | The index fields configured for the domain.
difsrsIndexFields :: Lens' DescribeIndexFieldsResponse [IndexFieldStatus]
instance Typeable DescribeIndexFields
instance Typeable DescribeIndexFieldsResponse
instance Eq DescribeIndexFields
instance Read DescribeIndexFields
instance Show DescribeIndexFields
instance Data DescribeIndexFields
instance Generic DescribeIndexFields
instance Eq DescribeIndexFieldsResponse
instance Read DescribeIndexFieldsResponse
instance Show DescribeIndexFieldsResponse
instance Data DescribeIndexFieldsResponse
instance Generic DescribeIndexFieldsResponse
instance Datatype D1DescribeIndexFields
instance Constructor C1_0DescribeIndexFields
instance Selector S1_0_0DescribeIndexFields
instance Selector S1_0_1DescribeIndexFields
instance Selector S1_0_2DescribeIndexFields
instance Datatype D1DescribeIndexFieldsResponse
instance Constructor C1_0DescribeIndexFieldsResponse
instance Selector S1_0_0DescribeIndexFieldsResponse
instance Selector S1_0_1DescribeIndexFieldsResponse
instance ToQuery DescribeIndexFields
instance ToPath DescribeIndexFields
instance ToHeaders DescribeIndexFields
instance AWSRequest DescribeIndexFields
-- | Creates a new search domain. For more information, see Creating a
-- Search Domain in the Amazon CloudSearch Developer Guide.
--
-- See: AWS API Reference for CreateDomain.
module Network.AWS.CloudSearch.CreateDomain
-- | Creates a value of CreateDomain with the minimum fields
-- required to make a request.
--
-- Use one of the following lenses to modify other fields as desired:
--
--
createDomain :: Text -> CreateDomain
-- | Container for the parameters to the CreateDomain operation.
-- Specifies a name for the new search domain.
--
-- See: createDomain smart constructor.
data CreateDomain
-- | A name for the domain you are creating. Allowed characters are a-z
-- (lower-case letters), 0-9, and hyphen (-). Domain names must start
-- with a letter or number and be at least 3 and no more than 28
-- characters long.
cdDomainName :: Lens' CreateDomain Text
-- | Creates a value of CreateDomainResponse with the minimum fields
-- required to make a request.
--
-- Use one of the following lenses to modify other fields as desired:
--
--
createDomainResponse :: Int -> CreateDomainResponse
-- | The result of a CreateDomainRequest. Contains the status of a
-- newly created domain.
--
-- See: createDomainResponse smart constructor.
data CreateDomainResponse
-- | Undocumented member.
cdrsDomainStatus :: Lens' CreateDomainResponse (Maybe DomainStatus)
-- | The response status code.
cdrsResponseStatus :: Lens' CreateDomainResponse Int
instance Typeable CreateDomain
instance Typeable CreateDomainResponse
instance Eq CreateDomain
instance Read CreateDomain
instance Show CreateDomain
instance Data CreateDomain
instance Generic CreateDomain
instance Eq CreateDomainResponse
instance Read CreateDomainResponse
instance Show CreateDomainResponse
instance Data CreateDomainResponse
instance Generic CreateDomainResponse
instance Datatype D1CreateDomain
instance Constructor C1_0CreateDomain
instance Selector S1_0_0CreateDomain
instance Datatype D1CreateDomainResponse
instance Constructor C1_0CreateDomainResponse
instance Selector S1_0_0CreateDomainResponse
instance Selector S1_0_1CreateDomainResponse
instance ToQuery CreateDomain
instance ToPath CreateDomain
instance ToHeaders CreateDomain
instance AWSRequest CreateDomain
-- | Gets the analysis schemes configured for a domain. An analysis scheme
-- defines language-specific text processing options for a text
-- field. Can be limited to specific analysis schemes by name. By
-- default, shows all analysis schemes and includes any pending changes
-- to the configuration. Set the Deployed option to
-- true to show the active configuration and exclude pending
-- changes. For more information, see Configuring Analysis Schemes
-- in the Amazon CloudSearch Developer Guide.
--
-- See: AWS API Reference for DescribeAnalysisSchemes.
module Network.AWS.CloudSearch.DescribeAnalysisSchemes
-- | Creates a value of DescribeAnalysisSchemes with the minimum
-- fields required to make a request.
--
-- Use one of the following lenses to modify other fields as desired:
--
--
describeAnalysisSchemes :: Text -> DescribeAnalysisSchemes
-- | 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.
--
-- See: describeAnalysisSchemes smart constructor.
data DescribeAnalysisSchemes
-- | Whether to display the deployed configuration (true) or
-- include any pending changes (false). Defaults to
-- false.
dassDeployed :: Lens' DescribeAnalysisSchemes (Maybe Bool)
-- | The analysis schemes you want to describe.
dassAnalysisSchemeNames :: Lens' DescribeAnalysisSchemes [Text]
-- | The name of the domain you want to describe.
dassDomainName :: Lens' DescribeAnalysisSchemes Text
-- | Creates a value of DescribeAnalysisSchemesResponse with the
-- minimum fields required to make a request.
--
-- Use one of the following lenses to modify other fields as desired:
--
--
describeAnalysisSchemesResponse :: Int -> DescribeAnalysisSchemesResponse
-- | The result of a DescribeAnalysisSchemes request. Contains the
-- analysis schemes configured for the domain specified in the request.
--
-- See: describeAnalysisSchemesResponse smart constructor.
data DescribeAnalysisSchemesResponse
-- | The response status code.
dasrsResponseStatus :: Lens' DescribeAnalysisSchemesResponse Int
-- | The analysis scheme descriptions.
dasrsAnalysisSchemes :: Lens' DescribeAnalysisSchemesResponse [AnalysisSchemeStatus]
instance Typeable DescribeAnalysisSchemes
instance Typeable DescribeAnalysisSchemesResponse
instance Eq DescribeAnalysisSchemes
instance Read DescribeAnalysisSchemes
instance Show DescribeAnalysisSchemes
instance Data DescribeAnalysisSchemes
instance Generic DescribeAnalysisSchemes
instance Eq DescribeAnalysisSchemesResponse
instance Read DescribeAnalysisSchemesResponse
instance Show DescribeAnalysisSchemesResponse
instance Data DescribeAnalysisSchemesResponse
instance Generic DescribeAnalysisSchemesResponse
instance Datatype D1DescribeAnalysisSchemes
instance Constructor C1_0DescribeAnalysisSchemes
instance Selector S1_0_0DescribeAnalysisSchemes
instance Selector S1_0_1DescribeAnalysisSchemes
instance Selector S1_0_2DescribeAnalysisSchemes
instance Datatype D1DescribeAnalysisSchemesResponse
instance Constructor C1_0DescribeAnalysisSchemesResponse
instance Selector S1_0_0DescribeAnalysisSchemesResponse
instance Selector S1_0_1DescribeAnalysisSchemesResponse
instance ToQuery DescribeAnalysisSchemes
instance ToPath DescribeAnalysisSchemes
instance ToHeaders DescribeAnalysisSchemes
instance AWSRequest DescribeAnalysisSchemes
-- | Deletes an analysis scheme. For more information, see Configuring
-- Analysis Schemes in the Amazon CloudSearch Developer Guide.
--
-- See: AWS API Reference for DeleteAnalysisScheme.
module Network.AWS.CloudSearch.DeleteAnalysisScheme
-- | Creates a value of DeleteAnalysisScheme with the minimum fields
-- required to make a request.
--
-- Use one of the following lenses to modify other fields as desired:
--
--
deleteAnalysisScheme :: Text -> Text -> DeleteAnalysisScheme
-- | 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.
--
-- See: deleteAnalysisScheme smart constructor.
data DeleteAnalysisScheme
-- | Undocumented member.
dasDomainName :: Lens' DeleteAnalysisScheme Text
-- | The name of the analysis scheme you want to delete.
dasAnalysisSchemeName :: Lens' DeleteAnalysisScheme Text
-- | Creates a value of DeleteAnalysisSchemeResponse with the
-- minimum fields required to make a request.
--
-- Use one of the following lenses to modify other fields as desired:
--
--
deleteAnalysisSchemeResponse :: Int -> AnalysisSchemeStatus -> DeleteAnalysisSchemeResponse
-- | The result of a DeleteAnalysisScheme request. Contains the
-- status of the deleted analysis scheme.
--
-- See: deleteAnalysisSchemeResponse smart constructor.
data DeleteAnalysisSchemeResponse
-- | The response status code.
dasarsResponseStatus :: Lens' DeleteAnalysisSchemeResponse Int
-- | The status of the analysis scheme being deleted.
dasarsAnalysisScheme :: Lens' DeleteAnalysisSchemeResponse AnalysisSchemeStatus
instance Typeable DeleteAnalysisScheme
instance Typeable DeleteAnalysisSchemeResponse
instance Eq DeleteAnalysisScheme
instance Read DeleteAnalysisScheme
instance Show DeleteAnalysisScheme
instance Data DeleteAnalysisScheme
instance Generic DeleteAnalysisScheme
instance Eq DeleteAnalysisSchemeResponse
instance Read DeleteAnalysisSchemeResponse
instance Show DeleteAnalysisSchemeResponse
instance Data DeleteAnalysisSchemeResponse
instance Generic DeleteAnalysisSchemeResponse
instance Datatype D1DeleteAnalysisScheme
instance Constructor C1_0DeleteAnalysisScheme
instance Selector S1_0_0DeleteAnalysisScheme
instance Selector S1_0_1DeleteAnalysisScheme
instance Datatype D1DeleteAnalysisSchemeResponse
instance Constructor C1_0DeleteAnalysisSchemeResponse
instance Selector S1_0_0DeleteAnalysisSchemeResponse
instance Selector S1_0_1DeleteAnalysisSchemeResponse
instance ToQuery DeleteAnalysisScheme
instance ToPath DeleteAnalysisScheme
instance ToHeaders DeleteAnalysisScheme
instance AWSRequest DeleteAnalysisScheme
-- | Gets information about the search domains owned by this account. Can
-- be limited to specific domains. Shows all domains by default. To get
-- the number of searchable documents in a domain, use the console or
-- submit a matchall request to your domain's search endpoint:
-- 'q=matchall&q.parser=structured&size=0'. For more
-- information, see Getting Information about a Search Domain in
-- the Amazon CloudSearch Developer Guide.
--
-- See: AWS API Reference for DescribeDomains.
module Network.AWS.CloudSearch.DescribeDomains
-- | Creates a value of DescribeDomains with the minimum fields
-- required to make a request.
--
-- Use one of the following lenses to modify other fields as desired:
--
--
describeDomains :: DescribeDomains
-- | 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.
--
-- See: describeDomains smart constructor.
data DescribeDomains
-- | The names of the domains you want to include in the response.
ddDomainNames :: Lens' DescribeDomains [Text]
-- | Creates a value of DescribeDomainsResponse with the minimum
-- fields required to make a request.
--
-- Use one of the following lenses to modify other fields as desired:
--
--
describeDomainsResponse :: Int -> DescribeDomainsResponse
-- | The result of a DescribeDomains request. Contains the status of
-- the domains specified in the request or all domains owned by the
-- account.
--
-- See: describeDomainsResponse smart constructor.
data DescribeDomainsResponse
-- | The response status code.
ddsrsResponseStatus :: Lens' DescribeDomainsResponse Int
-- | Undocumented member.
ddsrsDomainStatusList :: Lens' DescribeDomainsResponse [DomainStatus]
instance Typeable DescribeDomains
instance Typeable DescribeDomainsResponse
instance Eq DescribeDomains
instance Read DescribeDomains
instance Show DescribeDomains
instance Data DescribeDomains
instance Generic DescribeDomains
instance Eq DescribeDomainsResponse
instance Read DescribeDomainsResponse
instance Show DescribeDomainsResponse
instance Data DescribeDomainsResponse
instance Generic DescribeDomainsResponse
instance Datatype D1DescribeDomains
instance Constructor C1_0DescribeDomains
instance Selector S1_0_0DescribeDomains
instance Datatype D1DescribeDomainsResponse
instance Constructor C1_0DescribeDomainsResponse
instance Selector S1_0_0DescribeDomainsResponse
instance Selector S1_0_1DescribeDomainsResponse
instance ToQuery DescribeDomains
instance ToPath DescribeDomains
instance ToHeaders DescribeDomains
instance AWSRequest DescribeDomains
-- | Configures a suggester for a domain. A suggester enables you to
-- display possible matches before users finish typing their queries.
-- When you configure a suggester, you must specify the name of the text
-- field you want to search for possible matches and a unique name for
-- the suggester. For more information, see Getting Search
-- Suggestions in the Amazon CloudSearch Developer Guide.
--
-- See: AWS API Reference for DefineSuggester.
module Network.AWS.CloudSearch.DefineSuggester
-- | Creates a value of DefineSuggester with the minimum fields
-- required to make a request.
--
-- Use one of the following lenses to modify other fields as desired:
--
--
defineSuggester :: Text -> Suggester -> DefineSuggester
-- | Container for the parameters to the DefineSuggester operation.
-- Specifies the name of the domain you want to update and the suggester
-- configuration.
--
-- See: defineSuggester smart constructor.
data DefineSuggester
-- | Undocumented member.
defDomainName :: Lens' DefineSuggester Text
-- | Undocumented member.
defSuggester :: Lens' DefineSuggester Suggester
-- | Creates a value of DefineSuggesterResponse with the minimum
-- fields required to make a request.
--
-- Use one of the following lenses to modify other fields as desired:
--
--
defineSuggesterResponse :: Int -> SuggesterStatus -> DefineSuggesterResponse
-- | The result of a DefineSuggester request. Contains the status of
-- the newly-configured suggester.
--
-- See: defineSuggesterResponse smart constructor.
data DefineSuggesterResponse
-- | The response status code.
dsrsResponseStatus :: Lens' DefineSuggesterResponse Int
-- | Undocumented member.
dsrsSuggester :: Lens' DefineSuggesterResponse SuggesterStatus
instance Typeable DefineSuggester
instance Typeable DefineSuggesterResponse
instance Eq DefineSuggester
instance Read DefineSuggester
instance Show DefineSuggester
instance Data DefineSuggester
instance Generic DefineSuggester
instance Eq DefineSuggesterResponse
instance Read DefineSuggesterResponse
instance Show DefineSuggesterResponse
instance Data DefineSuggesterResponse
instance Generic DefineSuggesterResponse
instance Datatype D1DefineSuggester
instance Constructor C1_0DefineSuggester
instance Selector S1_0_0DefineSuggester
instance Selector S1_0_1DefineSuggester
instance Datatype D1DefineSuggesterResponse
instance Constructor C1_0DefineSuggesterResponse
instance Selector S1_0_0DefineSuggesterResponse
instance Selector S1_0_1DefineSuggesterResponse
instance ToQuery DefineSuggester
instance ToPath DefineSuggester
instance ToHeaders DefineSuggester
instance AWSRequest DefineSuggester
-- | Lists all search domains owned by an account.
--
-- See: AWS API Reference for ListDomainNames.
module Network.AWS.CloudSearch.ListDomainNames
-- | Creates a value of ListDomainNames with the minimum fields
-- required to make a request.
listDomainNames :: ListDomainNames
-- | See: listDomainNames smart constructor.
data ListDomainNames
-- | Creates a value of ListDomainNamesResponse with the minimum
-- fields required to make a request.
--
-- Use one of the following lenses to modify other fields as desired:
--
--
listDomainNamesResponse :: Int -> ListDomainNamesResponse
-- | The result of a ListDomainNames request. Contains a list of the
-- domains owned by an account.
--
-- See: listDomainNamesResponse smart constructor.
data ListDomainNamesResponse
-- | The names of the search domains owned by an account.
ldnrsDomainNames :: Lens' ListDomainNamesResponse (HashMap Text Text)
-- | The response status code.
ldnrsResponseStatus :: Lens' ListDomainNamesResponse Int
instance Typeable ListDomainNames
instance Typeable ListDomainNamesResponse
instance Eq ListDomainNames
instance Read ListDomainNames
instance Show ListDomainNames
instance Data ListDomainNames
instance Generic ListDomainNames
instance Eq ListDomainNamesResponse
instance Read ListDomainNamesResponse
instance Show ListDomainNamesResponse
instance Data ListDomainNamesResponse
instance Generic ListDomainNamesResponse
instance Datatype D1ListDomainNames
instance Constructor C1_0ListDomainNames
instance Datatype D1ListDomainNamesResponse
instance Constructor C1_0ListDomainNamesResponse
instance Selector S1_0_0ListDomainNamesResponse
instance Selector S1_0_1ListDomainNamesResponse
instance ToQuery ListDomainNames
instance ToPath ListDomainNames
instance ToHeaders ListDomainNames
instance AWSRequest ListDomainNames
-- | Removes an Expression from the search domain. For more
-- information, see Configuring Expressions in the Amazon
-- CloudSearch Developer Guide.
--
-- See: AWS API Reference for DeleteExpression.
module Network.AWS.CloudSearch.DeleteExpression
-- | Creates a value of DeleteExpression with the minimum fields
-- required to make a request.
--
-- Use one of the following lenses to modify other fields as desired:
--
--
deleteExpression :: Text -> Text -> DeleteExpression
-- | 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.
--
-- See: deleteExpression smart constructor.
data DeleteExpression
-- | Undocumented member.
delDomainName :: Lens' DeleteExpression Text
-- | The name of the Expression to delete.
delExpressionName :: Lens' DeleteExpression Text
-- | Creates a value of DeleteExpressionResponse with the minimum
-- fields required to make a request.
--
-- Use one of the following lenses to modify other fields as desired:
--
--
deleteExpressionResponse :: Int -> ExpressionStatus -> DeleteExpressionResponse
-- | The result of a DeleteExpression request. Specifies the
-- expression being deleted.
--
-- See: deleteExpressionResponse smart constructor.
data DeleteExpressionResponse
-- | The response status code.
delrsResponseStatus :: Lens' DeleteExpressionResponse Int
-- | The status of the expression being deleted.
delrsExpression :: Lens' DeleteExpressionResponse ExpressionStatus
instance Typeable DeleteExpression
instance Typeable DeleteExpressionResponse
instance Eq DeleteExpression
instance Read DeleteExpression
instance Show DeleteExpression
instance Data DeleteExpression
instance Generic DeleteExpression
instance Eq DeleteExpressionResponse
instance Read DeleteExpressionResponse
instance Show DeleteExpressionResponse
instance Data DeleteExpressionResponse
instance Generic DeleteExpressionResponse
instance Datatype D1DeleteExpression
instance Constructor C1_0DeleteExpression
instance Selector S1_0_0DeleteExpression
instance Selector S1_0_1DeleteExpression
instance Datatype D1DeleteExpressionResponse
instance Constructor C1_0DeleteExpressionResponse
instance Selector S1_0_0DeleteExpressionResponse
instance Selector S1_0_1DeleteExpressionResponse
instance ToQuery DeleteExpression
instance ToPath DeleteExpression
instance ToHeaders DeleteExpression
instance AWSRequest DeleteExpression
-- | Configures the availability options for a domain. Enabling the
-- Multi-AZ option expands an Amazon CloudSearch domain to an additional
-- Availability Zone in the same Region to increase fault tolerance in
-- the event of a service disruption. Changes to the Multi-AZ option can
-- take about half an hour to become active. For more information, see
-- Configuring Availability Options in the Amazon CloudSearch
-- Developer Guide.
--
-- See: AWS API Reference for UpdateAvailabilityOptions.
module Network.AWS.CloudSearch.UpdateAvailabilityOptions
-- | Creates a value of UpdateAvailabilityOptions with the minimum
-- fields required to make a request.
--
-- Use one of the following lenses to modify other fields as desired:
--
--
updateAvailabilityOptions :: Text -> Bool -> UpdateAvailabilityOptions
-- | Container for the parameters to the UpdateAvailabilityOptions
-- operation. Specifies the name of the domain you want to update and the
-- Multi-AZ availability option.
--
-- See: updateAvailabilityOptions smart constructor.
data UpdateAvailabilityOptions
-- | Undocumented member.
uaoDomainName :: Lens' UpdateAvailabilityOptions Text
-- | You expand an existing search domain to a second Availability Zone by
-- setting the Multi-AZ option to true. Similarly, you can turn off the
-- Multi-AZ option to downgrade the domain to a single Availability Zone
-- by setting the Multi-AZ option to false.
uaoMultiAZ :: Lens' UpdateAvailabilityOptions Bool
-- | Creates a value of UpdateAvailabilityOptionsResponse with the
-- minimum fields required to make a request.
--
-- Use one of the following lenses to modify other fields as desired:
--
--
updateAvailabilityOptionsResponse :: Int -> UpdateAvailabilityOptionsResponse
-- | The result of a UpdateAvailabilityOptions request. Contains the
-- status of the domain's availability options.
--
-- See: updateAvailabilityOptionsResponse smart
-- constructor.
data UpdateAvailabilityOptionsResponse
-- | The newly-configured availability options. Indicates whether Multi-AZ
-- is enabled for the domain.
uaorsAvailabilityOptions :: Lens' UpdateAvailabilityOptionsResponse (Maybe AvailabilityOptionsStatus)
-- | The response status code.
uaorsResponseStatus :: Lens' UpdateAvailabilityOptionsResponse Int
instance Typeable UpdateAvailabilityOptions
instance Typeable UpdateAvailabilityOptionsResponse
instance Eq UpdateAvailabilityOptions
instance Read UpdateAvailabilityOptions
instance Show UpdateAvailabilityOptions
instance Data UpdateAvailabilityOptions
instance Generic UpdateAvailabilityOptions
instance Eq UpdateAvailabilityOptionsResponse
instance Read UpdateAvailabilityOptionsResponse
instance Show UpdateAvailabilityOptionsResponse
instance Data UpdateAvailabilityOptionsResponse
instance Generic UpdateAvailabilityOptionsResponse
instance Datatype D1UpdateAvailabilityOptions
instance Constructor C1_0UpdateAvailabilityOptions
instance Selector S1_0_0UpdateAvailabilityOptions
instance Selector S1_0_1UpdateAvailabilityOptions
instance Datatype D1UpdateAvailabilityOptionsResponse
instance Constructor C1_0UpdateAvailabilityOptionsResponse
instance Selector S1_0_0UpdateAvailabilityOptionsResponse
instance Selector S1_0_1UpdateAvailabilityOptionsResponse
instance ToQuery UpdateAvailabilityOptions
instance ToPath UpdateAvailabilityOptions
instance ToHeaders UpdateAvailabilityOptions
instance AWSRequest UpdateAvailabilityOptions
-- | Gets the suggesters configured for a domain. A suggester enables you
-- to display possible matches before users finish typing their queries.
-- Can be limited to specific suggesters by name. By default, shows all
-- suggesters and includes any pending changes to the configuration. Set
-- the Deployed option to true to show the active
-- configuration and exclude pending changes. For more information, see
-- Getting Search Suggestions in the Amazon CloudSearch
-- Developer Guide.
--
-- See: AWS API Reference for DescribeSuggesters.
module Network.AWS.CloudSearch.DescribeSuggesters
-- | Creates a value of DescribeSuggesters with the minimum fields
-- required to make a request.
--
-- Use one of the following lenses to modify other fields as desired:
--
--
describeSuggesters :: Text -> DescribeSuggesters
-- | 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.
--
-- See: describeSuggesters smart constructor.
data DescribeSuggesters
-- | Whether to display the deployed configuration (true) or
-- include any pending changes (false). Defaults to
-- false.
dssDeployed :: Lens' DescribeSuggesters (Maybe Bool)
-- | The suggesters you want to describe.
dssSuggesterNames :: Lens' DescribeSuggesters [Text]
-- | The name of the domain you want to describe.
dssDomainName :: Lens' DescribeSuggesters Text
-- | Creates a value of DescribeSuggestersResponse with the minimum
-- fields required to make a request.
--
-- Use one of the following lenses to modify other fields as desired:
--
--
describeSuggestersResponse :: Int -> DescribeSuggestersResponse
-- | The result of a DescribeSuggesters request.
--
-- See: describeSuggestersResponse smart constructor.
data DescribeSuggestersResponse
-- | The response status code.
dssrsResponseStatus :: Lens' DescribeSuggestersResponse Int
-- | The suggesters configured for the domain specified in the request.
dssrsSuggesters :: Lens' DescribeSuggestersResponse [SuggesterStatus]
instance Typeable DescribeSuggesters
instance Typeable DescribeSuggestersResponse
instance Eq DescribeSuggesters
instance Read DescribeSuggesters
instance Show DescribeSuggesters
instance Data DescribeSuggesters
instance Generic DescribeSuggesters
instance Eq DescribeSuggestersResponse
instance Read DescribeSuggestersResponse
instance Show DescribeSuggestersResponse
instance Data DescribeSuggestersResponse
instance Generic DescribeSuggestersResponse
instance Datatype D1DescribeSuggesters
instance Constructor C1_0DescribeSuggesters
instance Selector S1_0_0DescribeSuggesters
instance Selector S1_0_1DescribeSuggesters
instance Selector S1_0_2DescribeSuggesters
instance Datatype D1DescribeSuggestersResponse
instance Constructor C1_0DescribeSuggestersResponse
instance Selector S1_0_0DescribeSuggestersResponse
instance Selector S1_0_1DescribeSuggestersResponse
instance ToQuery DescribeSuggesters
instance ToPath DescribeSuggesters
instance ToHeaders DescribeSuggesters
instance AWSRequest DescribeSuggesters
-- | Gets information about the access policies that control access to the
-- domain's document and search endpoints. By default, shows the
-- configuration with any pending changes. Set the Deployed
-- option to true to show the active configuration and exclude
-- pending changes. For more information, see Configuring Access for a
-- Search Domain in the Amazon CloudSearch Developer Guide.
--
-- See: AWS API Reference for
-- DescribeServiceAccessPolicies.
module Network.AWS.CloudSearch.DescribeServiceAccessPolicies
-- | Creates a value of DescribeServiceAccessPolicies with the
-- minimum fields required to make a request.
--
-- Use one of the following lenses to modify other fields as desired:
--
--
describeServiceAccessPolicies :: Text -> DescribeServiceAccessPolicies
-- | 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.
--
-- See: describeServiceAccessPolicies smart constructor.
data DescribeServiceAccessPolicies
-- | Whether to display the deployed configuration (true) or
-- include any pending changes (false). Defaults to
-- false.
dsapDeployed :: Lens' DescribeServiceAccessPolicies (Maybe Bool)
-- | The name of the domain you want to describe.
dsapDomainName :: Lens' DescribeServiceAccessPolicies Text
-- | Creates a value of DescribeServiceAccessPoliciesResponse with
-- the minimum fields required to make a request.
--
-- Use one of the following lenses to modify other fields as desired:
--
--
describeServiceAccessPoliciesResponse :: Int -> AccessPoliciesStatus -> DescribeServiceAccessPoliciesResponse
-- | The result of a DescribeServiceAccessPolicies request.
--
-- See: describeServiceAccessPoliciesResponse smart
-- constructor.
data DescribeServiceAccessPoliciesResponse
-- | The response status code.
dsaprsResponseStatus :: Lens' DescribeServiceAccessPoliciesResponse Int
-- | The access rules configured for the domain specified in the request.
dsaprsAccessPolicies :: Lens' DescribeServiceAccessPoliciesResponse AccessPoliciesStatus
instance Typeable DescribeServiceAccessPolicies
instance Typeable DescribeServiceAccessPoliciesResponse
instance Eq DescribeServiceAccessPolicies
instance Read DescribeServiceAccessPolicies
instance Show DescribeServiceAccessPolicies
instance Data DescribeServiceAccessPolicies
instance Generic DescribeServiceAccessPolicies
instance Eq DescribeServiceAccessPoliciesResponse
instance Read DescribeServiceAccessPoliciesResponse
instance Show DescribeServiceAccessPoliciesResponse
instance Data DescribeServiceAccessPoliciesResponse
instance Generic DescribeServiceAccessPoliciesResponse
instance Datatype D1DescribeServiceAccessPolicies
instance Constructor C1_0DescribeServiceAccessPolicies
instance Selector S1_0_0DescribeServiceAccessPolicies
instance Selector S1_0_1DescribeServiceAccessPolicies
instance Datatype D1DescribeServiceAccessPoliciesResponse
instance Constructor C1_0DescribeServiceAccessPoliciesResponse
instance Selector S1_0_0DescribeServiceAccessPoliciesResponse
instance Selector S1_0_1DescribeServiceAccessPoliciesResponse
instance ToQuery DescribeServiceAccessPolicies
instance ToPath DescribeServiceAccessPolicies
instance ToHeaders DescribeServiceAccessPolicies
instance AWSRequest DescribeServiceAccessPolicies
-- | Gets the scaling parameters configured for a domain. A domain's
-- scaling parameters specify the desired search instance type and
-- replication count. For more information, see Configuring Scaling
-- Options in the Amazon CloudSearch Developer Guide.
--
-- See: AWS API Reference for DescribeScalingParameters.
module Network.AWS.CloudSearch.DescribeScalingParameters
-- | Creates a value of DescribeScalingParameters with the minimum
-- fields required to make a request.
--
-- Use one of the following lenses to modify other fields as desired:
--
--
describeScalingParameters :: Text -> DescribeScalingParameters
-- | Container for the parameters to the DescribeScalingParameters
-- operation. Specifies the name of the domain you want to describe.
--
-- See: describeScalingParameters smart constructor.
data DescribeScalingParameters
-- | Undocumented member.
dspDomainName :: Lens' DescribeScalingParameters Text
-- | Creates a value of DescribeScalingParametersResponse with the
-- minimum fields required to make a request.
--
-- Use one of the following lenses to modify other fields as desired:
--
--
describeScalingParametersResponse :: Int -> ScalingParametersStatus -> DescribeScalingParametersResponse
-- | The result of a DescribeScalingParameters request. Contains the
-- scaling parameters configured for the domain specified in the request.
--
-- See: describeScalingParametersResponse smart
-- constructor.
data DescribeScalingParametersResponse
-- | The response status code.
dsprsResponseStatus :: Lens' DescribeScalingParametersResponse Int
-- | Undocumented member.
dsprsScalingParameters :: Lens' DescribeScalingParametersResponse ScalingParametersStatus
instance Typeable DescribeScalingParameters
instance Typeable DescribeScalingParametersResponse
instance Eq DescribeScalingParameters
instance Read DescribeScalingParameters
instance Show DescribeScalingParameters
instance Data DescribeScalingParameters
instance Generic DescribeScalingParameters
instance Eq DescribeScalingParametersResponse
instance Read DescribeScalingParametersResponse
instance Show DescribeScalingParametersResponse
instance Data DescribeScalingParametersResponse
instance Generic DescribeScalingParametersResponse
instance Datatype D1DescribeScalingParameters
instance Constructor C1_0DescribeScalingParameters
instance Selector S1_0_0DescribeScalingParameters
instance Datatype D1DescribeScalingParametersResponse
instance Constructor C1_0DescribeScalingParametersResponse
instance Selector S1_0_0DescribeScalingParametersResponse
instance Selector S1_0_1DescribeScalingParametersResponse
instance ToQuery DescribeScalingParameters
instance ToPath DescribeScalingParameters
instance ToHeaders DescribeScalingParameters
instance AWSRequest DescribeScalingParameters
-- | Configures an Expression for the search domain. Used to create
-- new expressions and modify existing ones. If the expression exists,
-- the new configuration replaces the old one. For more information, see
-- Configuring Expressions in the Amazon CloudSearch Developer
-- Guide.
--
-- See: AWS API Reference for DefineExpression.
module Network.AWS.CloudSearch.DefineExpression
-- | Creates a value of DefineExpression with the minimum fields
-- required to make a request.
--
-- Use one of the following lenses to modify other fields as desired:
--
--
defineExpression :: Text -> Expression -> DefineExpression
-- | 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.
--
-- See: defineExpression smart constructor.
data DefineExpression
-- | Undocumented member.
dDomainName :: Lens' DefineExpression Text
-- | Undocumented member.
dExpression :: Lens' DefineExpression Expression
-- | Creates a value of DefineExpressionResponse with the minimum
-- fields required to make a request.
--
-- Use one of the following lenses to modify other fields as desired:
--
--
defineExpressionResponse :: Int -> ExpressionStatus -> DefineExpressionResponse
-- | The result of a DefineExpression request. Contains the status
-- of the newly-configured expression.
--
-- See: defineExpressionResponse smart constructor.
data DefineExpressionResponse
-- | The response status code.
dersResponseStatus :: Lens' DefineExpressionResponse Int
-- | Undocumented member.
dersExpression :: Lens' DefineExpressionResponse ExpressionStatus
instance Typeable DefineExpression
instance Typeable DefineExpressionResponse
instance Eq DefineExpression
instance Read DefineExpression
instance Show DefineExpression
instance Data DefineExpression
instance Generic DefineExpression
instance Eq DefineExpressionResponse
instance Read DefineExpressionResponse
instance Show DefineExpressionResponse
instance Data DefineExpressionResponse
instance Generic DefineExpressionResponse
instance Datatype D1DefineExpression
instance Constructor C1_0DefineExpression
instance Selector S1_0_0DefineExpression
instance Selector S1_0_1DefineExpression
instance Datatype D1DefineExpressionResponse
instance Constructor C1_0DefineExpressionResponse
instance Selector S1_0_0DefineExpressionResponse
instance Selector S1_0_1DefineExpressionResponse
instance ToQuery DefineExpression
instance ToPath DefineExpression
instance ToHeaders DefineExpression
instance AWSRequest DefineExpression
-- | Gets the expressions configured for the search domain. Can be limited
-- to specific expressions by name. By default, shows all expressions and
-- includes any pending changes to the configuration. Set the
-- Deployed option to true to show the active
-- configuration and exclude pending changes. For more information, see
-- Configuring Expressions in the Amazon CloudSearch Developer
-- Guide.
--
-- See: AWS API Reference for DescribeExpressions.
module Network.AWS.CloudSearch.DescribeExpressions
-- | Creates a value of DescribeExpressions with the minimum fields
-- required to make a request.
--
-- Use one of the following lenses to modify other fields as desired:
--
--
describeExpressions :: Text -> DescribeExpressions
-- | 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.
--
-- See: describeExpressions smart constructor.
data DescribeExpressions
-- | Whether to display the deployed configuration (true) or
-- include any pending changes (false). Defaults to
-- false.
deDeployed :: Lens' DescribeExpressions (Maybe Bool)
-- | Limits the DescribeExpressions response to the specified
-- expressions. If not specified, all expressions are shown.
deExpressionNames :: Lens' DescribeExpressions [Text]
-- | The name of the domain you want to describe.
deDomainName :: Lens' DescribeExpressions Text
-- | Creates a value of DescribeExpressionsResponse with the minimum
-- fields required to make a request.
--
-- Use one of the following lenses to modify other fields as desired:
--
--
describeExpressionsResponse :: Int -> DescribeExpressionsResponse
-- | The result of a DescribeExpressions request. Contains the
-- expressions configured for the domain specified in the request.
--
-- See: describeExpressionsResponse smart constructor.
data DescribeExpressionsResponse
-- | The response status code.
drsResponseStatus :: Lens' DescribeExpressionsResponse Int
-- | The expressions configured for the domain.
drsExpressions :: Lens' DescribeExpressionsResponse [ExpressionStatus]
instance Typeable DescribeExpressions
instance Typeable DescribeExpressionsResponse
instance Eq DescribeExpressions
instance Read DescribeExpressions
instance Show DescribeExpressions
instance Data DescribeExpressions
instance Generic DescribeExpressions
instance Eq DescribeExpressionsResponse
instance Read DescribeExpressionsResponse
instance Show DescribeExpressionsResponse
instance Data DescribeExpressionsResponse
instance Generic DescribeExpressionsResponse
instance Datatype D1DescribeExpressions
instance Constructor C1_0DescribeExpressions
instance Selector S1_0_0DescribeExpressions
instance Selector S1_0_1DescribeExpressions
instance Selector S1_0_2DescribeExpressions
instance Datatype D1DescribeExpressionsResponse
instance Constructor C1_0DescribeExpressionsResponse
instance Selector S1_0_0DescribeExpressionsResponse
instance Selector S1_0_1DescribeExpressionsResponse
instance ToQuery DescribeExpressions
instance ToPath DescribeExpressions
instance ToHeaders DescribeExpressions
instance AWSRequest DescribeExpressions
-- | Gets the availability options configured for a domain. By default,
-- shows the configuration with any pending changes. Set the
-- Deployed option to true to show the active
-- configuration and exclude pending changes. For more information, see
-- Configuring Availability Options in the Amazon CloudSearch
-- Developer Guide.
--
-- See: AWS API Reference for DescribeAvailabilityOptions.
module Network.AWS.CloudSearch.DescribeAvailabilityOptions
-- | Creates a value of DescribeAvailabilityOptions with the minimum
-- fields required to make a request.
--
-- Use one of the following lenses to modify other fields as desired:
--
--
describeAvailabilityOptions :: Text -> DescribeAvailabilityOptions
-- | 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.
--
-- See: describeAvailabilityOptions smart constructor.
data DescribeAvailabilityOptions
-- | Whether to display the deployed configuration (true) or
-- include any pending changes (false). Defaults to
-- false.
daoDeployed :: Lens' DescribeAvailabilityOptions (Maybe Bool)
-- | The name of the domain you want to describe.
daoDomainName :: Lens' DescribeAvailabilityOptions Text
-- | Creates a value of DescribeAvailabilityOptionsResponse with the
-- minimum fields required to make a request.
--
-- Use one of the following lenses to modify other fields as desired:
--
--
describeAvailabilityOptionsResponse :: Int -> DescribeAvailabilityOptionsResponse
-- | The result of a DescribeAvailabilityOptions request. Indicates
-- whether or not the Multi-AZ option is enabled for the domain specified
-- in the request.
--
-- See: describeAvailabilityOptionsResponse smart
-- constructor.
data DescribeAvailabilityOptionsResponse
-- | The availability options configured for the domain. Indicates whether
-- Multi-AZ is enabled for the domain.
daorsAvailabilityOptions :: Lens' DescribeAvailabilityOptionsResponse (Maybe AvailabilityOptionsStatus)
-- | The response status code.
daorsResponseStatus :: Lens' DescribeAvailabilityOptionsResponse Int
instance Typeable DescribeAvailabilityOptions
instance Typeable DescribeAvailabilityOptionsResponse
instance Eq DescribeAvailabilityOptions
instance Read DescribeAvailabilityOptions
instance Show DescribeAvailabilityOptions
instance Data DescribeAvailabilityOptions
instance Generic DescribeAvailabilityOptions
instance Eq DescribeAvailabilityOptionsResponse
instance Read DescribeAvailabilityOptionsResponse
instance Show DescribeAvailabilityOptionsResponse
instance Data DescribeAvailabilityOptionsResponse
instance Generic DescribeAvailabilityOptionsResponse
instance Datatype D1DescribeAvailabilityOptions
instance Constructor C1_0DescribeAvailabilityOptions
instance Selector S1_0_0DescribeAvailabilityOptions
instance Selector S1_0_1DescribeAvailabilityOptions
instance Datatype D1DescribeAvailabilityOptionsResponse
instance Constructor C1_0DescribeAvailabilityOptionsResponse
instance Selector S1_0_0DescribeAvailabilityOptionsResponse
instance Selector S1_0_1DescribeAvailabilityOptionsResponse
instance ToQuery DescribeAvailabilityOptions
instance ToPath DescribeAvailabilityOptions
instance ToHeaders DescribeAvailabilityOptions
instance AWSRequest DescribeAvailabilityOptions
-- | 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
module Network.AWS.CloudSearch
-- | API version '2013-01-01' of the Amazon CloudSearch SDK configuration.
cloudSearch :: Service
-- | An error occurred while processing the request.
_BaseException :: AsError a => Getting (First ServiceError) a ServiceError
-- | The request was rejected because it attempted an operation which is
-- not enabled.
_DisabledOperationException :: AsError a => Getting (First ServiceError) a ServiceError
-- | An internal error occurred while processing the request. If this
-- problem persists, report an issue from the Service Health
-- Dashboard.
_InternalException :: AsError a => Getting (First ServiceError) a ServiceError
-- | The request was rejected because it specified an invalid type
-- definition.
_InvalidTypeException :: AsError a => Getting (First ServiceError) a ServiceError
-- | The request was rejected because it attempted to reference a resource
-- that does not exist.
_ResourceNotFoundException :: AsError a => Getting (First ServiceError) a ServiceError
-- | The request was rejected because a resource limit has already been
-- met.
_LimitExceededException :: AsError a => Getting (First ServiceError) a ServiceError
data AlgorithmicStemming
ASFull :: AlgorithmicStemming
ASLight :: AlgorithmicStemming
ASMinimal :: AlgorithmicStemming
ASNone :: AlgorithmicStemming
-- | An IETF RFC 4646 language code or mul for multiple
-- languages.
data AnalysisSchemeLanguage
AR :: AnalysisSchemeLanguage
BG :: AnalysisSchemeLanguage
CA :: AnalysisSchemeLanguage
CS :: AnalysisSchemeLanguage
DA :: AnalysisSchemeLanguage
DE :: AnalysisSchemeLanguage
EL :: AnalysisSchemeLanguage
EN :: AnalysisSchemeLanguage
ES :: AnalysisSchemeLanguage
EU :: AnalysisSchemeLanguage
FA :: AnalysisSchemeLanguage
FI :: AnalysisSchemeLanguage
FR :: AnalysisSchemeLanguage
GA :: AnalysisSchemeLanguage
GL :: AnalysisSchemeLanguage
HE :: AnalysisSchemeLanguage
HI :: AnalysisSchemeLanguage
HU :: AnalysisSchemeLanguage
HY :: AnalysisSchemeLanguage
IT :: AnalysisSchemeLanguage
Id :: AnalysisSchemeLanguage
JA :: AnalysisSchemeLanguage
KO :: AnalysisSchemeLanguage
LV :: AnalysisSchemeLanguage
Mul :: AnalysisSchemeLanguage
NL :: AnalysisSchemeLanguage
NO :: AnalysisSchemeLanguage
PT :: AnalysisSchemeLanguage
RO :: AnalysisSchemeLanguage
RU :: AnalysisSchemeLanguage
SV :: AnalysisSchemeLanguage
TH :: AnalysisSchemeLanguage
TR :: AnalysisSchemeLanguage
ZhHans :: AnalysisSchemeLanguage
ZhHant :: AnalysisSchemeLanguage
-- | 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.
data IndexFieldType
Date :: IndexFieldType
DateArray :: IndexFieldType
Double :: IndexFieldType
DoubleArray :: IndexFieldType
Int :: IndexFieldType
IntArray :: IndexFieldType
Latlon :: IndexFieldType
Literal :: IndexFieldType
LiteralArray :: IndexFieldType
Text :: IndexFieldType
TextArray :: IndexFieldType
-- | 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.
--
data OptionState
Active :: OptionState
FailedToValidate :: OptionState
Processing :: OptionState
RequiresIndexDocuments :: OptionState
-- | The instance type (such as 'search.m1.small') on which an index
-- partition is hosted.
data PartitionInstanceType
Search_M1_Large :: PartitionInstanceType
Search_M1_Small :: PartitionInstanceType
Search_M2_2XLarge :: PartitionInstanceType
Search_M2_XLarge :: PartitionInstanceType
Search_M3_2XLarge :: PartitionInstanceType
Search_M3_Large :: PartitionInstanceType
Search_M3_Medium :: PartitionInstanceType
Search_M3_XLarge :: PartitionInstanceType
data SuggesterFuzzyMatching
High :: SuggesterFuzzyMatching
Low :: SuggesterFuzzyMatching
None :: SuggesterFuzzyMatching
-- | The configured access rules for the domain's document and search
-- endpoints, and the current status of those rules.
--
-- See: accessPoliciesStatus smart constructor.
data 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:
--
--
accessPoliciesStatus :: Text -> OptionStatus -> AccessPoliciesStatus
-- | Undocumented member.
apsOptions :: Lens' AccessPoliciesStatus Text
-- | Undocumented member.
apsStatus :: Lens' AccessPoliciesStatus OptionStatus
-- | Synonyms, stopwords, and stemming options for an analysis scheme.
-- Includes tokenization dictionary for Japanese.
--
-- See: analysisOptions smart constructor.
data AnalysisOptions
-- | 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:
--
--
analysisOptions :: AnalysisOptions
-- | 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
aoAlgorithmicStemming :: Lens' AnalysisOptions (Maybe AlgorithmicStemming)
-- | 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.
aoStopwords :: Lens' AnalysisOptions (Maybe Text)
-- | 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.
aoJapaneseTokenizationDictionary :: Lens' AnalysisOptions (Maybe Text)
-- | 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.
aoSynonyms :: Lens' AnalysisOptions (Maybe Text)
-- | 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.
aoStemmingDictionary :: Lens' AnalysisOptions (Maybe Text)
-- | 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.
data 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:
--
--
analysisScheme :: Text -> AnalysisSchemeLanguage -> AnalysisScheme
-- | Undocumented member.
asAnalysisOptions :: Lens' AnalysisScheme (Maybe AnalysisOptions)
-- | Undocumented member.
asAnalysisSchemeName :: Lens' AnalysisScheme Text
-- | Undocumented member.
asAnalysisSchemeLanguage :: Lens' AnalysisScheme AnalysisSchemeLanguage
-- | The status and configuration of an AnalysisScheme.
--
-- See: analysisSchemeStatus smart constructor.
data 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:
--
--
analysisSchemeStatus :: AnalysisScheme -> OptionStatus -> AnalysisSchemeStatus
-- | Undocumented member.
assOptions :: Lens' AnalysisSchemeStatus AnalysisScheme
-- | Undocumented member.
assStatus :: Lens' AnalysisSchemeStatus OptionStatus
-- | The status and configuration of the domain's availability options.
--
-- See: availabilityOptionsStatus smart constructor.
data 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:
--
--
availabilityOptionsStatus :: Bool -> OptionStatus -> AvailabilityOptionsStatus
-- | The availability options configured for the domain.
aosOptions :: Lens' AvailabilityOptionsStatus Bool
-- | Undocumented member.
aosStatus :: Lens' AvailabilityOptionsStatus OptionStatus
-- | 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.
data DateArrayOptions
-- | 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:
--
--
dateArrayOptions :: DateArrayOptions
-- | A list of source fields to map to the field.
daosSourceFields :: Lens' DateArrayOptions (Maybe Text)
-- | Whether the contents of the field can be returned in the search
-- results.
daosReturnEnabled :: Lens' DateArrayOptions (Maybe Bool)
-- | Whether facet information can be returned for the field.
daosFacetEnabled :: Lens' DateArrayOptions (Maybe Bool)
-- | Whether the contents of the field are searchable.
daosSearchEnabled :: Lens' DateArrayOptions (Maybe Bool)
-- | A value to use for the field if the field isn't specified for a
-- document.
daosDefaultValue :: Lens' DateArrayOptions (Maybe Text)
-- | 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.
data DateOptions
-- | 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:
--
--
dateOptions :: DateOptions
-- | Undocumented member.
doSourceField :: Lens' DateOptions (Maybe Text)
-- | Whether the contents of the field can be returned in the search
-- results.
doReturnEnabled :: Lens' DateOptions (Maybe Bool)
-- | Whether facet information can be returned for the field.
doFacetEnabled :: Lens' DateOptions (Maybe Bool)
-- | Whether the contents of the field are searchable.
doSearchEnabled :: Lens' DateOptions (Maybe Bool)
-- | Whether the field can be used to sort the search results.
doSortEnabled :: Lens' DateOptions (Maybe Bool)
-- | A value to use for the field if the field isn't specified for a
-- document.
doDefaultValue :: Lens' DateOptions (Maybe Text)
-- | Options for a search suggester.
--
-- See: documentSuggesterOptions smart constructor.
data 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:
--
--
documentSuggesterOptions :: Text -> DocumentSuggesterOptions
-- | 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.
dsoSortExpression :: Lens' DocumentSuggesterOptions (Maybe Text)
-- | 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.
dsoFuzzyMatching :: Lens' DocumentSuggesterOptions (Maybe SuggesterFuzzyMatching)
-- | The name of the index field you want to use for suggestions.
dsoSourceField :: Lens' DocumentSuggesterOptions Text
-- | The current status of the search domain.
--
-- See: domainStatus smart constructor.
data 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:
--
--
domainStatus :: Text -> Text -> Bool -> DomainStatus
-- | The number of search instances that are available to process search
-- requests.
dsSearchInstanceCount :: Lens' DomainStatus (Maybe Natural)
-- | The instance type that is being used to process search requests.
dsSearchInstanceType :: Lens' DomainStatus (Maybe Text)
-- | The service endpoint for updating documents in a search domain.
dsDocService :: Lens' DomainStatus (Maybe ServiceEndpoint)
-- | Undocumented member.
dsARN :: Lens' DomainStatus (Maybe Text)
-- | 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.
dsCreated :: Lens' DomainStatus (Maybe Bool)
-- | The service endpoint for requesting search results from a search
-- domain.
dsSearchService :: Lens' DomainStatus (Maybe ServiceEndpoint)
-- | Undocumented member.
dsLimits :: Lens' DomainStatus (Maybe Limits)
-- | The number of partitions across which the search index is spread.
dsSearchPartitionCount :: Lens' DomainStatus (Maybe Natural)
-- | 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.
dsDeleted :: Lens' DomainStatus (Maybe Bool)
-- | True if processing is being done to activate the current domain
-- configuration.
dsProcessing :: Lens' DomainStatus (Maybe Bool)
-- | Undocumented member.
dsDomainId :: Lens' DomainStatus Text
-- | Undocumented member.
dsDomainName :: Lens' DomainStatus Text
-- | True if IndexDocuments needs to be called to activate the current
-- domain configuration.
dsRequiresIndexDocuments :: Lens' DomainStatus Bool
-- | 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.
data DoubleArrayOptions
-- | 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:
--
--
doubleArrayOptions :: DoubleArrayOptions
-- | A list of source fields to map to the field.
daoSourceFields :: Lens' DoubleArrayOptions (Maybe Text)
-- | Whether the contents of the field can be returned in the search
-- results.
daoReturnEnabled :: Lens' DoubleArrayOptions (Maybe Bool)
-- | Whether facet information can be returned for the field.
daoFacetEnabled :: Lens' DoubleArrayOptions (Maybe Bool)
-- | Whether the contents of the field are searchable.
daoSearchEnabled :: Lens' DoubleArrayOptions (Maybe Bool)
-- | A value to use for the field if the field isn't specified for a
-- document.
daoDefaultValue :: Lens' DoubleArrayOptions (Maybe Double)
-- | 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.
data DoubleOptions
-- | 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:
--
--
doubleOptions :: DoubleOptions
-- | The name of the source field to map to the field.
dSourceField :: Lens' DoubleOptions (Maybe Text)
-- | Whether the contents of the field can be returned in the search
-- results.
dReturnEnabled :: Lens' DoubleOptions (Maybe Bool)
-- | Whether facet information can be returned for the field.
dFacetEnabled :: Lens' DoubleOptions (Maybe Bool)
-- | Whether the contents of the field are searchable.
dSearchEnabled :: Lens' DoubleOptions (Maybe Bool)
-- | Whether the field can be used to sort the search results.
dSortEnabled :: Lens' DoubleOptions (Maybe Bool)
-- | 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.
dDefaultValue :: Lens' DoubleOptions (Maybe Double)
-- | 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.
data 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:
--
--
expression :: Text -> Text -> Expression
-- | Undocumented member.
eExpressionName :: Lens' Expression Text
-- | Undocumented member.
eExpressionValue :: Lens' Expression Text
-- | The value of an Expression and its current status.
--
-- See: expressionStatus smart constructor.
data 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:
--
--
expressionStatus :: Expression -> OptionStatus -> ExpressionStatus
-- | The expression that is evaluated for sorting while processing a search
-- request.
esOptions :: Lens' ExpressionStatus Expression
-- | Undocumented member.
esStatus :: Lens' ExpressionStatus OptionStatus
-- | 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.
data 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:
--
--
indexField :: Text -> IndexFieldType -> IndexField
-- | Undocumented member.
ifDoubleArrayOptions :: Lens' IndexField (Maybe DoubleArrayOptions)
-- | Undocumented member.
ifDateOptions :: Lens' IndexField (Maybe DateOptions)
-- | Undocumented member.
ifTextArrayOptions :: Lens' IndexField (Maybe TextArrayOptions)
-- | Undocumented member.
ifDoubleOptions :: Lens' IndexField (Maybe DoubleOptions)
-- | Undocumented member.
ifTextOptions :: Lens' IndexField (Maybe TextOptions)
-- | Undocumented member.
ifLatLonOptions :: Lens' IndexField (Maybe LatLonOptions)
-- | Undocumented member.
ifLiteralArrayOptions :: Lens' IndexField (Maybe LiteralArrayOptions)
-- | Undocumented member.
ifIntArrayOptions :: Lens' IndexField (Maybe IntArrayOptions)
-- | Undocumented member.
ifDateArrayOptions :: Lens' IndexField (Maybe DateArrayOptions)
-- | Undocumented member.
ifIntOptions :: Lens' IndexField (Maybe IntOptions)
-- | Undocumented member.
ifLiteralOptions :: Lens' IndexField (Maybe LiteralOptions)
-- | 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.
ifIndexFieldName :: Lens' IndexField Text
-- | Undocumented member.
ifIndexFieldType :: Lens' IndexField IndexFieldType
-- | The value of an IndexField and its current status.
--
-- See: indexFieldStatus smart constructor.
data 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:
--
--
indexFieldStatus :: IndexField -> OptionStatus -> IndexFieldStatus
-- | Undocumented member.
ifsOptions :: Lens' IndexFieldStatus IndexField
-- | Undocumented member.
ifsStatus :: Lens' IndexFieldStatus OptionStatus
-- | 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.
data IntArrayOptions
-- | 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:
--
--
intArrayOptions :: IntArrayOptions
-- | A list of source fields to map to the field.
iaoSourceFields :: Lens' IntArrayOptions (Maybe Text)
-- | Whether the contents of the field can be returned in the search
-- results.
iaoReturnEnabled :: Lens' IntArrayOptions (Maybe Bool)
-- | Whether facet information can be returned for the field.
iaoFacetEnabled :: Lens' IntArrayOptions (Maybe Bool)
-- | Whether the contents of the field are searchable.
iaoSearchEnabled :: Lens' IntArrayOptions (Maybe Bool)
-- | A value to use for the field if the field isn't specified for a
-- document.
iaoDefaultValue :: Lens' IntArrayOptions (Maybe Integer)
-- | 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.
data IntOptions
-- | 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:
--
--
intOptions :: IntOptions
-- | The name of the source field to map to the field.
ioSourceField :: Lens' IntOptions (Maybe Text)
-- | Whether the contents of the field can be returned in the search
-- results.
ioReturnEnabled :: Lens' IntOptions (Maybe Bool)
-- | Whether facet information can be returned for the field.
ioFacetEnabled :: Lens' IntOptions (Maybe Bool)
-- | Whether the contents of the field are searchable.
ioSearchEnabled :: Lens' IntOptions (Maybe Bool)
-- | Whether the field can be used to sort the search results.
ioSortEnabled :: Lens' IntOptions (Maybe Bool)
-- | 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.
ioDefaultValue :: Lens' IntOptions (Maybe Integer)
-- | 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.
data LatLonOptions
-- | 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:
--
--
latLonOptions :: LatLonOptions
-- | Undocumented member.
lloSourceField :: Lens' LatLonOptions (Maybe Text)
-- | Whether the contents of the field can be returned in the search
-- results.
lloReturnEnabled :: Lens' LatLonOptions (Maybe Bool)
-- | Whether facet information can be returned for the field.
lloFacetEnabled :: Lens' LatLonOptions (Maybe Bool)
-- | Whether the contents of the field are searchable.
lloSearchEnabled :: Lens' LatLonOptions (Maybe Bool)
-- | Whether the field can be used to sort the search results.
lloSortEnabled :: Lens' LatLonOptions (Maybe Bool)
-- | A value to use for the field if the field isn't specified for a
-- document.
lloDefaultValue :: Lens' LatLonOptions (Maybe Text)
-- | See: limits smart constructor.
data 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:
--
--
limits :: Natural -> Natural -> Limits
-- | Undocumented member.
lMaximumReplicationCount :: Lens' Limits Natural
-- | Undocumented member.
lMaximumPartitionCount :: Lens' Limits Natural
-- | 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.
data LiteralArrayOptions
-- | 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:
--
--
literalArrayOptions :: LiteralArrayOptions
-- | A list of source fields to map to the field.
laoSourceFields :: Lens' LiteralArrayOptions (Maybe Text)
-- | Whether the contents of the field can be returned in the search
-- results.
laoReturnEnabled :: Lens' LiteralArrayOptions (Maybe Bool)
-- | Whether facet information can be returned for the field.
laoFacetEnabled :: Lens' LiteralArrayOptions (Maybe Bool)
-- | Whether the contents of the field are searchable.
laoSearchEnabled :: Lens' LiteralArrayOptions (Maybe Bool)
-- | A value to use for the field if the field isn't specified for a
-- document.
laoDefaultValue :: Lens' LiteralArrayOptions (Maybe Text)
-- | Options for literal field. Present if IndexFieldType specifies
-- the field is of type literal. All options are enabled by
-- default.
--
-- See: literalOptions smart constructor.
data LiteralOptions
-- | 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:
--
--
literalOptions :: LiteralOptions
-- | Undocumented member.
loSourceField :: Lens' LiteralOptions (Maybe Text)
-- | Whether the contents of the field can be returned in the search
-- results.
loReturnEnabled :: Lens' LiteralOptions (Maybe Bool)
-- | Whether facet information can be returned for the field.
loFacetEnabled :: Lens' LiteralOptions (Maybe Bool)
-- | Whether the contents of the field are searchable.
loSearchEnabled :: Lens' LiteralOptions (Maybe Bool)
-- | Whether the field can be used to sort the search results.
loSortEnabled :: Lens' LiteralOptions (Maybe Bool)
-- | A value to use for the field if the field isn't specified for a
-- document.
loDefaultValue :: Lens' LiteralOptions (Maybe Text)
-- | The status of domain configuration option.
--
-- See: optionStatus smart constructor.
data 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:
--
--
optionStatus :: UTCTime -> UTCTime -> OptionState -> OptionStatus
-- | Indicates that the option will be deleted once processing is complete.
osPendingDeletion :: Lens' OptionStatus (Maybe Bool)
-- | A unique integer that indicates when this option was last updated.
osUpdateVersion :: Lens' OptionStatus (Maybe Natural)
-- | A timestamp for when this option was created.
osCreationDate :: Lens' OptionStatus UTCTime
-- | A timestamp for when this option was last updated.
osUpdateDate :: Lens' OptionStatus UTCTime
-- | 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.
--
osState :: Lens' OptionStatus OptionState
-- | The desired instance type and desired number of replicas of each index
-- partition.
--
-- See: scalingParameters smart constructor.
data ScalingParameters
-- | 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:
--
--
scalingParameters :: ScalingParameters
-- | The instance type that you want to preconfigure for your domain. For
-- example, 'search.m1.small'.
spDesiredInstanceType :: Lens' ScalingParameters (Maybe PartitionInstanceType)
-- | The number of replicas you want to preconfigure for each index
-- partition.
spDesiredReplicationCount :: Lens' ScalingParameters (Maybe Natural)
-- | The number of partitions you want to preconfigure for your domain.
-- Only valid when you select 'm2.2xlarge' as the desired instance type.
spDesiredPartitionCount :: Lens' ScalingParameters (Maybe Natural)
-- | The status and configuration of a search domain's scaling parameters.
--
-- See: scalingParametersStatus smart constructor.
data 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:
--
--
scalingParametersStatus :: ScalingParameters -> OptionStatus -> ScalingParametersStatus
-- | Undocumented member.
spsOptions :: Lens' ScalingParametersStatus ScalingParameters
-- | Undocumented member.
spsStatus :: Lens' ScalingParametersStatus OptionStatus
-- | The endpoint to which service requests can be submitted.
--
-- See: serviceEndpoint smart constructor.
data ServiceEndpoint
-- | 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:
--
--
serviceEndpoint :: ServiceEndpoint
-- | Undocumented member.
seEndpoint :: Lens' ServiceEndpoint (Maybe Text)
-- | 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.
data 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:
--
--
suggester :: Text -> DocumentSuggesterOptions -> Suggester
-- | Undocumented member.
sSuggesterName :: Lens' Suggester Text
-- | Undocumented member.
sDocumentSuggesterOptions :: Lens' Suggester DocumentSuggesterOptions
-- | The value of a Suggester and its current status.
--
-- See: suggesterStatus smart constructor.
data 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:
--
--
suggesterStatus :: Suggester -> OptionStatus -> SuggesterStatus
-- | Undocumented member.
ssOptions :: Lens' SuggesterStatus Suggester
-- | Undocumented member.
ssStatus :: Lens' SuggesterStatus OptionStatus
-- | 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.
data TextArrayOptions
-- | 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:
--
--
textArrayOptions :: TextArrayOptions
-- | A list of source fields to map to the field.
taoSourceFields :: Lens' TextArrayOptions (Maybe Text)
-- | Whether the contents of the field can be returned in the search
-- results.
taoReturnEnabled :: Lens' TextArrayOptions (Maybe Bool)
-- | The name of an analysis scheme for a 'text-array' field.
taoAnalysisScheme :: Lens' TextArrayOptions (Maybe Text)
-- | Whether highlights can be returned for the field.
taoHighlightEnabled :: Lens' TextArrayOptions (Maybe Bool)
-- | A value to use for the field if the field isn't specified for a
-- document.
taoDefaultValue :: Lens' TextArrayOptions (Maybe Text)
-- | 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.
data TextOptions
-- | 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:
--
--
textOptions :: TextOptions
-- | Undocumented member.
toSourceField :: Lens' TextOptions (Maybe Text)
-- | Whether the contents of the field can be returned in the search
-- results.
toReturnEnabled :: Lens' TextOptions (Maybe Bool)
-- | The name of an analysis scheme for a text field.
toAnalysisScheme :: Lens' TextOptions (Maybe Text)
-- | Whether highlights can be returned for the field.
toHighlightEnabled :: Lens' TextOptions (Maybe Bool)
-- | Whether the field can be used to sort the search results.
toSortEnabled :: Lens' TextOptions (Maybe Bool)
-- | A value to use for the field if the field isn't specified for a
-- document.
toDefaultValue :: Lens' TextOptions (Maybe Text)