| Copyright | (c) 2013-2021 Brendan Hay |
|---|---|
| License | Mozilla Public License, v. 2.0. |
| Maintainer | Brendan Hay <brendan.g.hay+amazonka@gmail.com> |
| Stability | auto-generated |
| Portability | non-portable (GHC extensions) |
| Safe Haskell | None |
Amazonka.CloudSearch.Types
Contents
- Service Configuration
- Errors
- AlgorithmicStemming
- AnalysisSchemeLanguage
- IndexFieldType
- OptionState
- PartitionInstanceType
- SuggesterFuzzyMatching
- TLSSecurityPolicy
- AccessPoliciesStatus
- AnalysisOptions
- AnalysisScheme
- AnalysisSchemeStatus
- AvailabilityOptionsStatus
- DateArrayOptions
- DateOptions
- DocumentSuggesterOptions
- DomainEndpointOptions
- DomainEndpointOptionsStatus
- DomainStatus
- DoubleArrayOptions
- DoubleOptions
- Expression
- ExpressionStatus
- IndexField
- IndexFieldStatus
- IntArrayOptions
- IntOptions
- LatLonOptions
- Limits
- LiteralArrayOptions
- LiteralOptions
- OptionStatus
- ScalingParameters
- ScalingParametersStatus
- ServiceEndpoint
- Suggester
- SuggesterStatus
- TextArrayOptions
- TextOptions
Description
Synopsis
- defaultService :: Service
- _ValidationException :: AsError a => Getting (First ServiceError) a ServiceError
- _ResourceAlreadyExistsException :: AsError a => Getting (First ServiceError) a ServiceError
- _BaseException :: AsError a => Getting (First ServiceError) a ServiceError
- _DisabledOperationException :: AsError a => Getting (First ServiceError) a ServiceError
- _InternalException :: AsError a => Getting (First ServiceError) a ServiceError
- _InvalidTypeException :: AsError a => Getting (First ServiceError) a ServiceError
- _ResourceNotFoundException :: AsError a => Getting (First ServiceError) a ServiceError
- _LimitExceededException :: AsError a => Getting (First ServiceError) a ServiceError
- newtype AlgorithmicStemming where
- AlgorithmicStemming' { }
- pattern AlgorithmicStemming_Full :: AlgorithmicStemming
- pattern AlgorithmicStemming_Light :: AlgorithmicStemming
- pattern AlgorithmicStemming_Minimal :: AlgorithmicStemming
- pattern AlgorithmicStemming_None :: AlgorithmicStemming
- newtype AnalysisSchemeLanguage where
- AnalysisSchemeLanguage' { }
- pattern AnalysisSchemeLanguage_Ar :: AnalysisSchemeLanguage
- pattern AnalysisSchemeLanguage_Bg :: AnalysisSchemeLanguage
- pattern AnalysisSchemeLanguage_Ca :: AnalysisSchemeLanguage
- pattern AnalysisSchemeLanguage_Cs :: AnalysisSchemeLanguage
- pattern AnalysisSchemeLanguage_Da :: AnalysisSchemeLanguage
- pattern AnalysisSchemeLanguage_De :: AnalysisSchemeLanguage
- pattern AnalysisSchemeLanguage_El :: AnalysisSchemeLanguage
- pattern AnalysisSchemeLanguage_En :: AnalysisSchemeLanguage
- pattern AnalysisSchemeLanguage_Es :: AnalysisSchemeLanguage
- pattern AnalysisSchemeLanguage_Eu :: AnalysisSchemeLanguage
- pattern AnalysisSchemeLanguage_Fa :: AnalysisSchemeLanguage
- pattern AnalysisSchemeLanguage_Fi :: AnalysisSchemeLanguage
- pattern AnalysisSchemeLanguage_Fr :: AnalysisSchemeLanguage
- pattern AnalysisSchemeLanguage_Ga :: AnalysisSchemeLanguage
- pattern AnalysisSchemeLanguage_Gl :: AnalysisSchemeLanguage
- pattern AnalysisSchemeLanguage_He :: AnalysisSchemeLanguage
- pattern AnalysisSchemeLanguage_Hi :: AnalysisSchemeLanguage
- pattern AnalysisSchemeLanguage_Hu :: AnalysisSchemeLanguage
- pattern AnalysisSchemeLanguage_Hy :: AnalysisSchemeLanguage
- pattern AnalysisSchemeLanguage_Id :: AnalysisSchemeLanguage
- pattern AnalysisSchemeLanguage_It :: AnalysisSchemeLanguage
- pattern AnalysisSchemeLanguage_Ja :: AnalysisSchemeLanguage
- pattern AnalysisSchemeLanguage_Ko :: AnalysisSchemeLanguage
- pattern AnalysisSchemeLanguage_Lv :: AnalysisSchemeLanguage
- pattern AnalysisSchemeLanguage_Mul :: AnalysisSchemeLanguage
- pattern AnalysisSchemeLanguage_Nl :: AnalysisSchemeLanguage
- pattern AnalysisSchemeLanguage_No :: AnalysisSchemeLanguage
- pattern AnalysisSchemeLanguage_Pt :: AnalysisSchemeLanguage
- pattern AnalysisSchemeLanguage_Ro :: AnalysisSchemeLanguage
- pattern AnalysisSchemeLanguage_Ru :: AnalysisSchemeLanguage
- pattern AnalysisSchemeLanguage_Sv :: AnalysisSchemeLanguage
- pattern AnalysisSchemeLanguage_Th :: AnalysisSchemeLanguage
- pattern AnalysisSchemeLanguage_Tr :: AnalysisSchemeLanguage
- pattern AnalysisSchemeLanguage_Zh_Hans :: AnalysisSchemeLanguage
- pattern AnalysisSchemeLanguage_Zh_Hant :: AnalysisSchemeLanguage
- newtype IndexFieldType where
- IndexFieldType' { }
- pattern IndexFieldType_Date :: IndexFieldType
- pattern IndexFieldType_Date_array :: IndexFieldType
- pattern IndexFieldType_Double :: IndexFieldType
- pattern IndexFieldType_Double_array :: IndexFieldType
- pattern IndexFieldType_Int :: IndexFieldType
- pattern IndexFieldType_Int_array :: IndexFieldType
- pattern IndexFieldType_Latlon :: IndexFieldType
- pattern IndexFieldType_Literal :: IndexFieldType
- pattern IndexFieldType_Literal_array :: IndexFieldType
- pattern IndexFieldType_Text :: IndexFieldType
- pattern IndexFieldType_Text_array :: IndexFieldType
- newtype OptionState where
- OptionState' { }
- pattern OptionState_Active :: OptionState
- pattern OptionState_FailedToValidate :: OptionState
- pattern OptionState_Processing :: OptionState
- pattern OptionState_RequiresIndexDocuments :: OptionState
- newtype PartitionInstanceType where
- PartitionInstanceType' { }
- pattern PartitionInstanceType_Search_2xlarge :: PartitionInstanceType
- pattern PartitionInstanceType_Search_large :: PartitionInstanceType
- pattern PartitionInstanceType_Search_m1_large :: PartitionInstanceType
- pattern PartitionInstanceType_Search_m1_small :: PartitionInstanceType
- pattern PartitionInstanceType_Search_m2_2xlarge :: PartitionInstanceType
- pattern PartitionInstanceType_Search_m2_xlarge :: PartitionInstanceType
- pattern PartitionInstanceType_Search_m3_2xlarge :: PartitionInstanceType
- pattern PartitionInstanceType_Search_m3_large :: PartitionInstanceType
- pattern PartitionInstanceType_Search_m3_medium :: PartitionInstanceType
- pattern PartitionInstanceType_Search_m3_xlarge :: PartitionInstanceType
- pattern PartitionInstanceType_Search_medium :: PartitionInstanceType
- pattern PartitionInstanceType_Search_previousgeneration_2xlarge :: PartitionInstanceType
- pattern PartitionInstanceType_Search_previousgeneration_large :: PartitionInstanceType
- pattern PartitionInstanceType_Search_previousgeneration_small :: PartitionInstanceType
- pattern PartitionInstanceType_Search_previousgeneration_xlarge :: PartitionInstanceType
- pattern PartitionInstanceType_Search_small :: PartitionInstanceType
- pattern PartitionInstanceType_Search_xlarge :: PartitionInstanceType
- newtype SuggesterFuzzyMatching where
- newtype TLSSecurityPolicy where
- data AccessPoliciesStatus = AccessPoliciesStatus' {
- options :: Text
- status :: OptionStatus
- newAccessPoliciesStatus :: Text -> OptionStatus -> AccessPoliciesStatus
- accessPoliciesStatus_options :: Lens' AccessPoliciesStatus Text
- accessPoliciesStatus_status :: Lens' AccessPoliciesStatus OptionStatus
- data AnalysisOptions = AnalysisOptions' {}
- newAnalysisOptions :: AnalysisOptions
- analysisOptions_algorithmicStemming :: Lens' AnalysisOptions (Maybe AlgorithmicStemming)
- analysisOptions_stopwords :: Lens' AnalysisOptions (Maybe Text)
- analysisOptions_japaneseTokenizationDictionary :: Lens' AnalysisOptions (Maybe Text)
- analysisOptions_synonyms :: Lens' AnalysisOptions (Maybe Text)
- analysisOptions_stemmingDictionary :: Lens' AnalysisOptions (Maybe Text)
- data AnalysisScheme = AnalysisScheme' {}
- newAnalysisScheme :: Text -> AnalysisSchemeLanguage -> AnalysisScheme
- analysisScheme_analysisOptions :: Lens' AnalysisScheme (Maybe AnalysisOptions)
- analysisScheme_analysisSchemeName :: Lens' AnalysisScheme Text
- analysisScheme_analysisSchemeLanguage :: Lens' AnalysisScheme AnalysisSchemeLanguage
- data AnalysisSchemeStatus = AnalysisSchemeStatus' {}
- newAnalysisSchemeStatus :: AnalysisScheme -> OptionStatus -> AnalysisSchemeStatus
- analysisSchemeStatus_options :: Lens' AnalysisSchemeStatus AnalysisScheme
- analysisSchemeStatus_status :: Lens' AnalysisSchemeStatus OptionStatus
- data AvailabilityOptionsStatus = AvailabilityOptionsStatus' {
- options :: Bool
- status :: OptionStatus
- newAvailabilityOptionsStatus :: Bool -> OptionStatus -> AvailabilityOptionsStatus
- availabilityOptionsStatus_options :: Lens' AvailabilityOptionsStatus Bool
- availabilityOptionsStatus_status :: Lens' AvailabilityOptionsStatus OptionStatus
- data DateArrayOptions = DateArrayOptions' {}
- newDateArrayOptions :: DateArrayOptions
- dateArrayOptions_sourceFields :: Lens' DateArrayOptions (Maybe Text)
- dateArrayOptions_returnEnabled :: Lens' DateArrayOptions (Maybe Bool)
- dateArrayOptions_facetEnabled :: Lens' DateArrayOptions (Maybe Bool)
- dateArrayOptions_searchEnabled :: Lens' DateArrayOptions (Maybe Bool)
- dateArrayOptions_defaultValue :: Lens' DateArrayOptions (Maybe Text)
- data DateOptions = DateOptions' {}
- newDateOptions :: DateOptions
- dateOptions_sourceField :: Lens' DateOptions (Maybe Text)
- dateOptions_returnEnabled :: Lens' DateOptions (Maybe Bool)
- dateOptions_facetEnabled :: Lens' DateOptions (Maybe Bool)
- dateOptions_searchEnabled :: Lens' DateOptions (Maybe Bool)
- dateOptions_sortEnabled :: Lens' DateOptions (Maybe Bool)
- dateOptions_defaultValue :: Lens' DateOptions (Maybe Text)
- data DocumentSuggesterOptions = DocumentSuggesterOptions' {}
- newDocumentSuggesterOptions :: Text -> DocumentSuggesterOptions
- documentSuggesterOptions_sortExpression :: Lens' DocumentSuggesterOptions (Maybe Text)
- documentSuggesterOptions_fuzzyMatching :: Lens' DocumentSuggesterOptions (Maybe SuggesterFuzzyMatching)
- documentSuggesterOptions_sourceField :: Lens' DocumentSuggesterOptions Text
- data DomainEndpointOptions = DomainEndpointOptions' {}
- newDomainEndpointOptions :: DomainEndpointOptions
- domainEndpointOptions_enforceHTTPS :: Lens' DomainEndpointOptions (Maybe Bool)
- domainEndpointOptions_tLSSecurityPolicy :: Lens' DomainEndpointOptions (Maybe TLSSecurityPolicy)
- data DomainEndpointOptionsStatus = DomainEndpointOptionsStatus' {}
- newDomainEndpointOptionsStatus :: DomainEndpointOptions -> OptionStatus -> DomainEndpointOptionsStatus
- domainEndpointOptionsStatus_options :: Lens' DomainEndpointOptionsStatus DomainEndpointOptions
- domainEndpointOptionsStatus_status :: Lens' DomainEndpointOptionsStatus OptionStatus
- data DomainStatus = DomainStatus' {
- searchInstanceCount :: Maybe Natural
- searchInstanceType :: Maybe Text
- docService :: Maybe ServiceEndpoint
- arn :: Maybe Text
- created :: Maybe Bool
- searchService :: Maybe ServiceEndpoint
- limits :: Maybe Limits
- searchPartitionCount :: Maybe Natural
- deleted :: Maybe Bool
- processing :: Maybe Bool
- domainId :: Text
- domainName :: Text
- requiresIndexDocuments :: Bool
- newDomainStatus :: Text -> Text -> Bool -> DomainStatus
- domainStatus_searchInstanceCount :: Lens' DomainStatus (Maybe Natural)
- domainStatus_searchInstanceType :: Lens' DomainStatus (Maybe Text)
- domainStatus_docService :: Lens' DomainStatus (Maybe ServiceEndpoint)
- domainStatus_arn :: Lens' DomainStatus (Maybe Text)
- domainStatus_created :: Lens' DomainStatus (Maybe Bool)
- domainStatus_searchService :: Lens' DomainStatus (Maybe ServiceEndpoint)
- domainStatus_limits :: Lens' DomainStatus (Maybe Limits)
- domainStatus_searchPartitionCount :: Lens' DomainStatus (Maybe Natural)
- domainStatus_deleted :: Lens' DomainStatus (Maybe Bool)
- domainStatus_processing :: Lens' DomainStatus (Maybe Bool)
- domainStatus_domainId :: Lens' DomainStatus Text
- domainStatus_domainName :: Lens' DomainStatus Text
- domainStatus_requiresIndexDocuments :: Lens' DomainStatus Bool
- data DoubleArrayOptions = DoubleArrayOptions' {}
- newDoubleArrayOptions :: DoubleArrayOptions
- doubleArrayOptions_sourceFields :: Lens' DoubleArrayOptions (Maybe Text)
- doubleArrayOptions_returnEnabled :: Lens' DoubleArrayOptions (Maybe Bool)
- doubleArrayOptions_facetEnabled :: Lens' DoubleArrayOptions (Maybe Bool)
- doubleArrayOptions_searchEnabled :: Lens' DoubleArrayOptions (Maybe Bool)
- doubleArrayOptions_defaultValue :: Lens' DoubleArrayOptions (Maybe Double)
- data DoubleOptions = DoubleOptions' {}
- newDoubleOptions :: DoubleOptions
- doubleOptions_sourceField :: Lens' DoubleOptions (Maybe Text)
- doubleOptions_returnEnabled :: Lens' DoubleOptions (Maybe Bool)
- doubleOptions_facetEnabled :: Lens' DoubleOptions (Maybe Bool)
- doubleOptions_searchEnabled :: Lens' DoubleOptions (Maybe Bool)
- doubleOptions_sortEnabled :: Lens' DoubleOptions (Maybe Bool)
- doubleOptions_defaultValue :: Lens' DoubleOptions (Maybe Double)
- data Expression = Expression' {}
- newExpression :: Text -> Text -> Expression
- expression_expressionName :: Lens' Expression Text
- expression_expressionValue :: Lens' Expression Text
- data ExpressionStatus = ExpressionStatus' {}
- newExpressionStatus :: Expression -> OptionStatus -> ExpressionStatus
- expressionStatus_options :: Lens' ExpressionStatus Expression
- expressionStatus_status :: Lens' ExpressionStatus OptionStatus
- data IndexField = IndexField' {
- doubleArrayOptions :: Maybe DoubleArrayOptions
- dateOptions :: Maybe DateOptions
- textArrayOptions :: Maybe TextArrayOptions
- doubleOptions :: Maybe DoubleOptions
- textOptions :: Maybe TextOptions
- latLonOptions :: Maybe LatLonOptions
- literalArrayOptions :: Maybe LiteralArrayOptions
- intArrayOptions :: Maybe IntArrayOptions
- dateArrayOptions :: Maybe DateArrayOptions
- intOptions :: Maybe IntOptions
- literalOptions :: Maybe LiteralOptions
- indexFieldName :: Text
- indexFieldType :: IndexFieldType
- newIndexField :: Text -> IndexFieldType -> IndexField
- indexField_doubleArrayOptions :: Lens' IndexField (Maybe DoubleArrayOptions)
- indexField_dateOptions :: Lens' IndexField (Maybe DateOptions)
- indexField_textArrayOptions :: Lens' IndexField (Maybe TextArrayOptions)
- indexField_doubleOptions :: Lens' IndexField (Maybe DoubleOptions)
- indexField_textOptions :: Lens' IndexField (Maybe TextOptions)
- indexField_latLonOptions :: Lens' IndexField (Maybe LatLonOptions)
- indexField_literalArrayOptions :: Lens' IndexField (Maybe LiteralArrayOptions)
- indexField_intArrayOptions :: Lens' IndexField (Maybe IntArrayOptions)
- indexField_dateArrayOptions :: Lens' IndexField (Maybe DateArrayOptions)
- indexField_intOptions :: Lens' IndexField (Maybe IntOptions)
- indexField_literalOptions :: Lens' IndexField (Maybe LiteralOptions)
- indexField_indexFieldName :: Lens' IndexField Text
- indexField_indexFieldType :: Lens' IndexField IndexFieldType
- data IndexFieldStatus = IndexFieldStatus' {}
- newIndexFieldStatus :: IndexField -> OptionStatus -> IndexFieldStatus
- indexFieldStatus_options :: Lens' IndexFieldStatus IndexField
- indexFieldStatus_status :: Lens' IndexFieldStatus OptionStatus
- data IntArrayOptions = IntArrayOptions' {}
- newIntArrayOptions :: IntArrayOptions
- intArrayOptions_sourceFields :: Lens' IntArrayOptions (Maybe Text)
- intArrayOptions_returnEnabled :: Lens' IntArrayOptions (Maybe Bool)
- intArrayOptions_facetEnabled :: Lens' IntArrayOptions (Maybe Bool)
- intArrayOptions_searchEnabled :: Lens' IntArrayOptions (Maybe Bool)
- intArrayOptions_defaultValue :: Lens' IntArrayOptions (Maybe Integer)
- data IntOptions = IntOptions' {}
- newIntOptions :: IntOptions
- intOptions_sourceField :: Lens' IntOptions (Maybe Text)
- intOptions_returnEnabled :: Lens' IntOptions (Maybe Bool)
- intOptions_facetEnabled :: Lens' IntOptions (Maybe Bool)
- intOptions_searchEnabled :: Lens' IntOptions (Maybe Bool)
- intOptions_sortEnabled :: Lens' IntOptions (Maybe Bool)
- intOptions_defaultValue :: Lens' IntOptions (Maybe Integer)
- data LatLonOptions = LatLonOptions' {}
- newLatLonOptions :: LatLonOptions
- latLonOptions_sourceField :: Lens' LatLonOptions (Maybe Text)
- latLonOptions_returnEnabled :: Lens' LatLonOptions (Maybe Bool)
- latLonOptions_facetEnabled :: Lens' LatLonOptions (Maybe Bool)
- latLonOptions_searchEnabled :: Lens' LatLonOptions (Maybe Bool)
- latLonOptions_sortEnabled :: Lens' LatLonOptions (Maybe Bool)
- latLonOptions_defaultValue :: Lens' LatLonOptions (Maybe Text)
- data Limits = Limits' {}
- newLimits :: Natural -> Natural -> Limits
- limits_maximumReplicationCount :: Lens' Limits Natural
- limits_maximumPartitionCount :: Lens' Limits Natural
- data LiteralArrayOptions = LiteralArrayOptions' {}
- newLiteralArrayOptions :: LiteralArrayOptions
- literalArrayOptions_sourceFields :: Lens' LiteralArrayOptions (Maybe Text)
- literalArrayOptions_returnEnabled :: Lens' LiteralArrayOptions (Maybe Bool)
- literalArrayOptions_facetEnabled :: Lens' LiteralArrayOptions (Maybe Bool)
- literalArrayOptions_searchEnabled :: Lens' LiteralArrayOptions (Maybe Bool)
- literalArrayOptions_defaultValue :: Lens' LiteralArrayOptions (Maybe Text)
- data LiteralOptions = LiteralOptions' {}
- newLiteralOptions :: LiteralOptions
- literalOptions_sourceField :: Lens' LiteralOptions (Maybe Text)
- literalOptions_returnEnabled :: Lens' LiteralOptions (Maybe Bool)
- literalOptions_facetEnabled :: Lens' LiteralOptions (Maybe Bool)
- literalOptions_searchEnabled :: Lens' LiteralOptions (Maybe Bool)
- literalOptions_sortEnabled :: Lens' LiteralOptions (Maybe Bool)
- literalOptions_defaultValue :: Lens' LiteralOptions (Maybe Text)
- data OptionStatus = OptionStatus' {}
- newOptionStatus :: UTCTime -> UTCTime -> OptionState -> OptionStatus
- optionStatus_pendingDeletion :: Lens' OptionStatus (Maybe Bool)
- optionStatus_updateVersion :: Lens' OptionStatus (Maybe Natural)
- optionStatus_creationDate :: Lens' OptionStatus UTCTime
- optionStatus_updateDate :: Lens' OptionStatus UTCTime
- optionStatus_state :: Lens' OptionStatus OptionState
- data ScalingParameters = ScalingParameters' {}
- newScalingParameters :: ScalingParameters
- scalingParameters_desiredInstanceType :: Lens' ScalingParameters (Maybe PartitionInstanceType)
- scalingParameters_desiredReplicationCount :: Lens' ScalingParameters (Maybe Natural)
- scalingParameters_desiredPartitionCount :: Lens' ScalingParameters (Maybe Natural)
- data ScalingParametersStatus = ScalingParametersStatus' {}
- newScalingParametersStatus :: ScalingParameters -> OptionStatus -> ScalingParametersStatus
- scalingParametersStatus_options :: Lens' ScalingParametersStatus ScalingParameters
- scalingParametersStatus_status :: Lens' ScalingParametersStatus OptionStatus
- data ServiceEndpoint = ServiceEndpoint' {}
- newServiceEndpoint :: ServiceEndpoint
- serviceEndpoint_endpoint :: Lens' ServiceEndpoint (Maybe Text)
- data Suggester = Suggester' {}
- newSuggester :: Text -> DocumentSuggesterOptions -> Suggester
- suggester_suggesterName :: Lens' Suggester Text
- suggester_documentSuggesterOptions :: Lens' Suggester DocumentSuggesterOptions
- data SuggesterStatus = SuggesterStatus' {}
- newSuggesterStatus :: Suggester -> OptionStatus -> SuggesterStatus
- suggesterStatus_options :: Lens' SuggesterStatus Suggester
- suggesterStatus_status :: Lens' SuggesterStatus OptionStatus
- data TextArrayOptions = TextArrayOptions' {}
- newTextArrayOptions :: TextArrayOptions
- textArrayOptions_sourceFields :: Lens' TextArrayOptions (Maybe Text)
- textArrayOptions_returnEnabled :: Lens' TextArrayOptions (Maybe Bool)
- textArrayOptions_analysisScheme :: Lens' TextArrayOptions (Maybe Text)
- textArrayOptions_highlightEnabled :: Lens' TextArrayOptions (Maybe Bool)
- textArrayOptions_defaultValue :: Lens' TextArrayOptions (Maybe Text)
- data TextOptions = TextOptions' {}
- newTextOptions :: TextOptions
- textOptions_sourceField :: Lens' TextOptions (Maybe Text)
- textOptions_returnEnabled :: Lens' TextOptions (Maybe Bool)
- textOptions_analysisScheme :: Lens' TextOptions (Maybe Text)
- textOptions_highlightEnabled :: Lens' TextOptions (Maybe Bool)
- textOptions_sortEnabled :: Lens' TextOptions (Maybe Bool)
- textOptions_defaultValue :: Lens' TextOptions (Maybe Text)
Service Configuration
defaultService :: Service Source #
API version 2013-01-01 of the Amazon CloudSearch SDK configuration.
Errors
_ValidationException :: AsError a => Getting (First ServiceError) a ServiceError Source #
The request was rejected because it has invalid parameters.
_ResourceAlreadyExistsException :: AsError a => Getting (First ServiceError) a ServiceError Source #
The request was rejected because it attempted to create a resource that already exists.
_BaseException :: AsError a => Getting (First ServiceError) a ServiceError Source #
An error occurred while processing the request.
_DisabledOperationException :: AsError a => Getting (First ServiceError) a ServiceError Source #
The request was rejected because it attempted an operation which is not enabled.
_InternalException :: AsError a => Getting (First ServiceError) a ServiceError Source #
An internal error occurred while processing the request. If this problem persists, report an issue from the Service Health Dashboard.
_InvalidTypeException :: AsError a => Getting (First ServiceError) a ServiceError Source #
The request was rejected because it specified an invalid type definition.
_ResourceNotFoundException :: AsError a => Getting (First ServiceError) a ServiceError Source #
The request was rejected because it attempted to reference a resource that does not exist.
_LimitExceededException :: AsError a => Getting (First ServiceError) a ServiceError Source #
The request was rejected because a resource limit has already been met.
AlgorithmicStemming
newtype AlgorithmicStemming Source #
Constructors
| AlgorithmicStemming' | |
Fields | |
Bundled Patterns
| pattern AlgorithmicStemming_Full :: AlgorithmicStemming | |
| pattern AlgorithmicStemming_Light :: AlgorithmicStemming | |
| pattern AlgorithmicStemming_Minimal :: AlgorithmicStemming | |
| pattern AlgorithmicStemming_None :: AlgorithmicStemming |
Instances
AnalysisSchemeLanguage
newtype AnalysisSchemeLanguage Source #
An IETF RFC 4646 language code or
mul for multiple languages.
Constructors
| AnalysisSchemeLanguage' | |
Fields | |
Bundled Patterns
Instances
IndexFieldType
newtype IndexFieldType Source #
The type of field. The valid options for a field depend on the field type. For more information about the supported field types, see Configuring Index Fields in the Amazon CloudSearch Developer Guide.
Constructors
| IndexFieldType' | |
Fields | |
Bundled Patterns
| pattern IndexFieldType_Date :: IndexFieldType | |
| pattern IndexFieldType_Date_array :: IndexFieldType | |
| pattern IndexFieldType_Double :: IndexFieldType | |
| pattern IndexFieldType_Double_array :: IndexFieldType | |
| pattern IndexFieldType_Int :: IndexFieldType | |
| pattern IndexFieldType_Int_array :: IndexFieldType | |
| pattern IndexFieldType_Latlon :: IndexFieldType | |
| pattern IndexFieldType_Literal :: IndexFieldType | |
| pattern IndexFieldType_Literal_array :: IndexFieldType | |
| pattern IndexFieldType_Text :: IndexFieldType | |
| pattern IndexFieldType_Text_array :: IndexFieldType |
Instances
OptionState
newtype OptionState Source #
The state of processing a change to an option. One of:
- RequiresIndexDocuments: The option's latest value will not be deployed until IndexDocuments has been called and indexing is complete.
- Processing: The option's latest value is in the process of being activated.
- Active: The option's latest value is fully deployed.
- FailedToValidate: The option value is not compatible with the domain's data and cannot be used to index the data. You must either modify the option value or update or remove the incompatible documents.
Constructors
| OptionState' | |
Fields | |
Bundled Patterns
| pattern OptionState_Active :: OptionState | |
| pattern OptionState_FailedToValidate :: OptionState | |
| pattern OptionState_Processing :: OptionState | |
| pattern OptionState_RequiresIndexDocuments :: OptionState |
Instances
PartitionInstanceType
newtype PartitionInstanceType Source #
The instance type (such as search.m1.small) on which an index
partition is hosted.
Constructors
| PartitionInstanceType' | |
Fields | |
Bundled Patterns
Instances
SuggesterFuzzyMatching
newtype SuggesterFuzzyMatching Source #
Constructors
| SuggesterFuzzyMatching' | |
Fields | |
Bundled Patterns
| pattern SuggesterFuzzyMatching_High :: SuggesterFuzzyMatching | |
| pattern SuggesterFuzzyMatching_Low :: SuggesterFuzzyMatching | |
| pattern SuggesterFuzzyMatching_None :: SuggesterFuzzyMatching |
Instances
TLSSecurityPolicy
newtype TLSSecurityPolicy Source #
The minimum required TLS version.
Constructors
| TLSSecurityPolicy' | |
Fields | |
Bundled Patterns
| pattern TLSSecurityPolicy_Policy_Min_TLS_1_0_2019_07 :: TLSSecurityPolicy | |
| pattern TLSSecurityPolicy_Policy_Min_TLS_1_2_2019_07 :: TLSSecurityPolicy |
Instances
AccessPoliciesStatus
data AccessPoliciesStatus Source #
The configured access rules for the domain's document and search endpoints, and the current status of those rules.
See: newAccessPoliciesStatus smart constructor.
Constructors
| AccessPoliciesStatus' | |
Fields
| |
Instances
newAccessPoliciesStatus Source #
Arguments
| :: Text | |
| -> OptionStatus | |
| -> AccessPoliciesStatus |
Create a value of AccessPoliciesStatus with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:options:AccessPoliciesStatus', accessPoliciesStatus_options - Undocumented member.
$sel:status:AccessPoliciesStatus', accessPoliciesStatus_status - Undocumented member.
accessPoliciesStatus_options :: Lens' AccessPoliciesStatus Text Source #
Undocumented member.
accessPoliciesStatus_status :: Lens' AccessPoliciesStatus OptionStatus Source #
Undocumented member.
AnalysisOptions
data AnalysisOptions Source #
Synonyms, stopwords, and stemming options for an analysis scheme. Includes tokenization dictionary for Japanese.
See: newAnalysisOptions smart constructor.
Constructors
| AnalysisOptions' | |
Fields
| |
Instances
newAnalysisOptions :: AnalysisOptions Source #
Create a value of AnalysisOptions with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:algorithmicStemming:AnalysisOptions', analysisOptions_algorithmicStemming - 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
$sel:stopwords:AnalysisOptions', analysisOptions_stopwords - 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.
$sel:japaneseTokenizationDictionary:AnalysisOptions', analysisOptions_japaneseTokenizationDictionary - 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.
$sel:synonyms:AnalysisOptions', analysisOptions_synonyms - 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.
$sel:stemmingDictionary:AnalysisOptions', analysisOptions_stemmingDictionary - 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.
analysisOptions_algorithmicStemming :: Lens' AnalysisOptions (Maybe AlgorithmicStemming) Source #
The level of algorithmic stemming to perform: none, minimal,
light, or full. The available levels vary depending on the language.
For more information, see
Language Specific Text Processing Settings
in the Amazon CloudSearch Developer Guide
analysisOptions_stopwords :: Lens' AnalysisOptions (Maybe Text) Source #
A JSON array of terms to ignore during indexing and searching. For
example, ["a", "an", "the", "of"]. The stopwords dictionary
must explicitly list each word you want to ignore. Wildcards and regular
expressions are not supported.
analysisOptions_japaneseTokenizationDictionary :: Lens' AnalysisOptions (Maybe Text) Source #
A JSON array that contains a collection of terms, tokens, readings and part of speech for Japanese Tokenizaiton. The Japanese tokenization dictionary enables you to override the default tokenization for selected terms. This is only valid for Japanese language fields.
analysisOptions_synonyms :: Lens' AnalysisOptions (Maybe Text) Source #
A JSON object that defines synonym groups and aliases. A synonym group is an array of arrays, where each sub-array is a group of terms where each term in the group is considered a synonym of every other term in the group. The aliases value is an object that contains a collection of string:value pairs where the string specifies a term and the array of values specifies each of the aliases for that term. An alias is considered a synonym of the specified term, but the term is not considered a synonym of the alias. For more information about specifying synonyms, see Synonyms in the Amazon CloudSearch Developer Guide.
analysisOptions_stemmingDictionary :: Lens' AnalysisOptions (Maybe Text) Source #
A JSON object that contains a collection of string:value pairs that each
map a term to its stem. For example,
{"term1": "stem1", "term2": "stem2", "term3": "stem3"}.
The stemming dictionary is applied in addition to any algorithmic
stemming. This enables you to override the results of the algorithmic
stemming to correct specific cases of overstemming or understemming. The
maximum size of a stemming dictionary is 500 KB.
AnalysisScheme
data AnalysisScheme Source #
Configuration information for an analysis scheme. Each analysis scheme
has a unique name and specifies the language of the text to be
processed. The following options can be configured for an analysis
scheme: Synonyms, Stopwords, StemmingDictionary,
JapaneseTokenizationDictionary and AlgorithmicStemming.
See: newAnalysisScheme smart constructor.
Constructors
| AnalysisScheme' | |
Instances
Arguments
| :: Text | |
| -> AnalysisSchemeLanguage | |
| -> AnalysisScheme |
Create a value of AnalysisScheme with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:analysisOptions:AnalysisScheme', analysisScheme_analysisOptions - Undocumented member.
$sel:analysisSchemeName:AnalysisScheme', analysisScheme_analysisSchemeName - Undocumented member.
$sel:analysisSchemeLanguage:AnalysisScheme', analysisScheme_analysisSchemeLanguage - Undocumented member.
analysisScheme_analysisOptions :: Lens' AnalysisScheme (Maybe AnalysisOptions) Source #
Undocumented member.
analysisScheme_analysisSchemeName :: Lens' AnalysisScheme Text Source #
Undocumented member.
analysisScheme_analysisSchemeLanguage :: Lens' AnalysisScheme AnalysisSchemeLanguage Source #
Undocumented member.
AnalysisSchemeStatus
data AnalysisSchemeStatus Source #
The status and configuration of an AnalysisScheme.
See: newAnalysisSchemeStatus smart constructor.
Constructors
| AnalysisSchemeStatus' | |
Fields | |
Instances
newAnalysisSchemeStatus Source #
Arguments
| :: AnalysisScheme | |
| -> OptionStatus | |
| -> AnalysisSchemeStatus |
Create a value of AnalysisSchemeStatus with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:options:AnalysisSchemeStatus', analysisSchemeStatus_options - Undocumented member.
$sel:status:AnalysisSchemeStatus', analysisSchemeStatus_status - Undocumented member.
analysisSchemeStatus_options :: Lens' AnalysisSchemeStatus AnalysisScheme Source #
Undocumented member.
analysisSchemeStatus_status :: Lens' AnalysisSchemeStatus OptionStatus Source #
Undocumented member.
AvailabilityOptionsStatus
data AvailabilityOptionsStatus Source #
The status and configuration of the domain's availability options.
See: newAvailabilityOptionsStatus smart constructor.
Constructors
| AvailabilityOptionsStatus' | |
Fields
| |
Instances
newAvailabilityOptionsStatus Source #
Arguments
| :: Bool | |
| -> OptionStatus | |
| -> AvailabilityOptionsStatus |
Create a value of AvailabilityOptionsStatus with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:options:AvailabilityOptionsStatus', availabilityOptionsStatus_options - The availability options configured for the domain.
$sel:status:AvailabilityOptionsStatus', availabilityOptionsStatus_status - Undocumented member.
availabilityOptionsStatus_options :: Lens' AvailabilityOptionsStatus Bool Source #
The availability options configured for the domain.
availabilityOptionsStatus_status :: Lens' AvailabilityOptionsStatus OptionStatus Source #
Undocumented member.
DateArrayOptions
data DateArrayOptions Source #
Options for a field that contains an array of dates. Present if
IndexFieldType specifies the field is of type date-array. All
options are enabled by default.
See: newDateArrayOptions smart constructor.
Constructors
| DateArrayOptions' | |
Fields
| |
Instances
newDateArrayOptions :: DateArrayOptions Source #
Create a value of DateArrayOptions with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:sourceFields:DateArrayOptions', dateArrayOptions_sourceFields - A list of source fields to map to the field.
$sel:returnEnabled:DateArrayOptions', dateArrayOptions_returnEnabled - Whether the contents of the field can be returned in the search results.
$sel:facetEnabled:DateArrayOptions', dateArrayOptions_facetEnabled - Whether facet information can be returned for the field.
$sel:searchEnabled:DateArrayOptions', dateArrayOptions_searchEnabled - Whether the contents of the field are searchable.
$sel:defaultValue:DateArrayOptions', dateArrayOptions_defaultValue - A value to use for the field if the field isn't specified for a
document.
dateArrayOptions_sourceFields :: Lens' DateArrayOptions (Maybe Text) Source #
A list of source fields to map to the field.
dateArrayOptions_returnEnabled :: Lens' DateArrayOptions (Maybe Bool) Source #
Whether the contents of the field can be returned in the search results.
dateArrayOptions_facetEnabled :: Lens' DateArrayOptions (Maybe Bool) Source #
Whether facet information can be returned for the field.
dateArrayOptions_searchEnabled :: Lens' DateArrayOptions (Maybe Bool) Source #
Whether the contents of the field are searchable.
dateArrayOptions_defaultValue :: Lens' DateArrayOptions (Maybe Text) Source #
A value to use for the field if the field isn't specified for a document.
DateOptions
data DateOptions Source #
Options for a date field. Dates and times are specified in UTC
(Coordinated Universal Time) according to IETF RFC3339:
yyyy-mm-ddT00:00:00Z. Present if IndexFieldType specifies the field is
of type date. All options are enabled by default.
See: newDateOptions smart constructor.
Constructors
| DateOptions' | |
Fields
| |
Instances
newDateOptions :: DateOptions Source #
Create a value of DateOptions with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:sourceField:DateOptions', dateOptions_sourceField - Undocumented member.
$sel:returnEnabled:DateOptions', dateOptions_returnEnabled - Whether the contents of the field can be returned in the search results.
$sel:facetEnabled:DateOptions', dateOptions_facetEnabled - Whether facet information can be returned for the field.
$sel:searchEnabled:DateOptions', dateOptions_searchEnabled - Whether the contents of the field are searchable.
$sel:sortEnabled:DateOptions', dateOptions_sortEnabled - Whether the field can be used to sort the search results.
$sel:defaultValue:DateOptions', dateOptions_defaultValue - A value to use for the field if the field isn't specified for a
document.
dateOptions_sourceField :: Lens' DateOptions (Maybe Text) Source #
Undocumented member.
dateOptions_returnEnabled :: Lens' DateOptions (Maybe Bool) Source #
Whether the contents of the field can be returned in the search results.
dateOptions_facetEnabled :: Lens' DateOptions (Maybe Bool) Source #
Whether facet information can be returned for the field.
dateOptions_searchEnabled :: Lens' DateOptions (Maybe Bool) Source #
Whether the contents of the field are searchable.
dateOptions_sortEnabled :: Lens' DateOptions (Maybe Bool) Source #
Whether the field can be used to sort the search results.
dateOptions_defaultValue :: Lens' DateOptions (Maybe Text) Source #
A value to use for the field if the field isn't specified for a document.
DocumentSuggesterOptions
data DocumentSuggesterOptions Source #
Options for a search suggester.
See: newDocumentSuggesterOptions smart constructor.
Constructors
| DocumentSuggesterOptions' | |
Fields
| |
Instances
newDocumentSuggesterOptions Source #
Create a value of DocumentSuggesterOptions with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:sortExpression:DocumentSuggesterOptions', documentSuggesterOptions_sortExpression - 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.
$sel:fuzzyMatching:DocumentSuggesterOptions', documentSuggesterOptions_fuzzyMatching - 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.
$sel:sourceField:DocumentSuggesterOptions', documentSuggesterOptions_sourceField - The name of the index field you want to use for suggestions.
documentSuggesterOptions_sortExpression :: Lens' DocumentSuggesterOptions (Maybe Text) Source #
An expression that computes a score for each suggestion to control how
they are sorted. The scores are rounded to the nearest integer, with a
floor of 0 and a ceiling of 2^31-1. A document's relevance score is not
computed for suggestions, so sort expressions cannot reference the
_score value. To sort suggestions using a numeric field or existing
expression, simply specify the name of the field or expression. If no
expression is configured for the suggester, the suggestions are sorted
with the closest matches listed first.
documentSuggesterOptions_fuzzyMatching :: Lens' DocumentSuggesterOptions (Maybe SuggesterFuzzyMatching) Source #
The level of fuzziness allowed when suggesting matches for a string:
none, low, or high. With none, the specified string is treated as
an exact prefix. With low, suggestions must differ from the specified
string by no more than one character. With high, suggestions can differ
by up to two characters. The default is none.
documentSuggesterOptions_sourceField :: Lens' DocumentSuggesterOptions Text Source #
The name of the index field you want to use for suggestions.
DomainEndpointOptions
data DomainEndpointOptions Source #
The domain's endpoint options.
See: newDomainEndpointOptions smart constructor.
Constructors
| DomainEndpointOptions' | |
Fields
| |
Instances
newDomainEndpointOptions :: DomainEndpointOptions Source #
Create a value of DomainEndpointOptions with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:enforceHTTPS:DomainEndpointOptions', domainEndpointOptions_enforceHTTPS - Whether the domain is HTTPS only enabled.
$sel:tLSSecurityPolicy:DomainEndpointOptions', domainEndpointOptions_tLSSecurityPolicy - The minimum required TLS version
domainEndpointOptions_enforceHTTPS :: Lens' DomainEndpointOptions (Maybe Bool) Source #
Whether the domain is HTTPS only enabled.
domainEndpointOptions_tLSSecurityPolicy :: Lens' DomainEndpointOptions (Maybe TLSSecurityPolicy) Source #
The minimum required TLS version
DomainEndpointOptionsStatus
data DomainEndpointOptionsStatus Source #
The configuration and status of the domain's endpoint options.
See: newDomainEndpointOptionsStatus smart constructor.
Constructors
| DomainEndpointOptionsStatus' | |
Fields
| |
Instances
newDomainEndpointOptionsStatus Source #
Arguments
| :: DomainEndpointOptions | |
| -> OptionStatus | |
| -> DomainEndpointOptionsStatus |
Create a value of DomainEndpointOptionsStatus with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:options:DomainEndpointOptionsStatus', domainEndpointOptionsStatus_options - The domain endpoint options configured for the domain.
$sel:status:DomainEndpointOptionsStatus', domainEndpointOptionsStatus_status - The status of the configured domain endpoint options.
domainEndpointOptionsStatus_options :: Lens' DomainEndpointOptionsStatus DomainEndpointOptions Source #
The domain endpoint options configured for the domain.
domainEndpointOptionsStatus_status :: Lens' DomainEndpointOptionsStatus OptionStatus Source #
The status of the configured domain endpoint options.
DomainStatus
data DomainStatus Source #
The current status of the search domain.
See: newDomainStatus smart constructor.
Constructors
| DomainStatus' | |
Fields
| |
Instances
Arguments
| :: Text | |
| -> Text | |
| -> Bool | |
| -> DomainStatus |
Create a value of DomainStatus with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:searchInstanceCount:DomainStatus', domainStatus_searchInstanceCount - The number of search instances that are available to process search
requests.
$sel:searchInstanceType:DomainStatus', domainStatus_searchInstanceType - The instance type that is being used to process search requests.
$sel:docService:DomainStatus', domainStatus_docService - The service endpoint for updating documents in a search domain.
$sel:arn:DomainStatus', domainStatus_arn - Undocumented member.
$sel:created:DomainStatus', domainStatus_created - 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.
$sel:searchService:DomainStatus', domainStatus_searchService - The service endpoint for requesting search results from a search domain.
$sel:limits:DomainStatus', domainStatus_limits - Undocumented member.
$sel:searchPartitionCount:DomainStatus', domainStatus_searchPartitionCount - The number of partitions across which the search index is spread.
$sel:deleted:DomainStatus', domainStatus_deleted - 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.
$sel:processing:DomainStatus', domainStatus_processing - True if processing is being done to activate the current domain
configuration.
$sel:domainId:DomainStatus', domainStatus_domainId - Undocumented member.
$sel:domainName:DomainStatus', domainStatus_domainName - Undocumented member.
$sel:requiresIndexDocuments:DomainStatus', domainStatus_requiresIndexDocuments - True if IndexDocuments needs to be called to activate the current domain
configuration.
domainStatus_searchInstanceCount :: Lens' DomainStatus (Maybe Natural) Source #
The number of search instances that are available to process search requests.
domainStatus_searchInstanceType :: Lens' DomainStatus (Maybe Text) Source #
The instance type that is being used to process search requests.
domainStatus_docService :: Lens' DomainStatus (Maybe ServiceEndpoint) Source #
The service endpoint for updating documents in a search domain.
domainStatus_arn :: Lens' DomainStatus (Maybe Text) Source #
Undocumented member.
domainStatus_created :: Lens' DomainStatus (Maybe Bool) Source #
True if the search domain is created. It can take several minutes to initialize a domain when CreateDomain is called. Newly created search domains are returned from DescribeDomains with a false value for Created until domain creation is complete.
domainStatus_searchService :: Lens' DomainStatus (Maybe ServiceEndpoint) Source #
The service endpoint for requesting search results from a search domain.
domainStatus_limits :: Lens' DomainStatus (Maybe Limits) Source #
Undocumented member.
domainStatus_searchPartitionCount :: Lens' DomainStatus (Maybe Natural) Source #
The number of partitions across which the search index is spread.
domainStatus_deleted :: Lens' DomainStatus (Maybe Bool) Source #
True if the search domain has been deleted. The system must clean up resources dedicated to the search domain when DeleteDomain is called. Newly deleted search domains are returned from DescribeDomains with a true value for IsDeleted for several minutes until resource cleanup is complete.
domainStatus_processing :: Lens' DomainStatus (Maybe Bool) Source #
True if processing is being done to activate the current domain configuration.
domainStatus_domainId :: Lens' DomainStatus Text Source #
Undocumented member.
domainStatus_domainName :: Lens' DomainStatus Text Source #
Undocumented member.
domainStatus_requiresIndexDocuments :: Lens' DomainStatus Bool Source #
True if IndexDocuments needs to be called to activate the current domain configuration.
DoubleArrayOptions
data DoubleArrayOptions Source #
Options for a field that contains an array of double-precision 64-bit
floating point values. Present if IndexFieldType specifies the field
is of type double-array. All options are enabled by default.
See: newDoubleArrayOptions smart constructor.
Constructors
| DoubleArrayOptions' | |
Fields
| |
Instances
newDoubleArrayOptions :: DoubleArrayOptions Source #
Create a value of DoubleArrayOptions with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:sourceFields:DoubleArrayOptions', doubleArrayOptions_sourceFields - A list of source fields to map to the field.
$sel:returnEnabled:DoubleArrayOptions', doubleArrayOptions_returnEnabled - Whether the contents of the field can be returned in the search results.
$sel:facetEnabled:DoubleArrayOptions', doubleArrayOptions_facetEnabled - Whether facet information can be returned for the field.
$sel:searchEnabled:DoubleArrayOptions', doubleArrayOptions_searchEnabled - Whether the contents of the field are searchable.
$sel:defaultValue:DoubleArrayOptions', doubleArrayOptions_defaultValue - A value to use for the field if the field isn't specified for a
document.
doubleArrayOptions_sourceFields :: Lens' DoubleArrayOptions (Maybe Text) Source #
A list of source fields to map to the field.
doubleArrayOptions_returnEnabled :: Lens' DoubleArrayOptions (Maybe Bool) Source #
Whether the contents of the field can be returned in the search results.
doubleArrayOptions_facetEnabled :: Lens' DoubleArrayOptions (Maybe Bool) Source #
Whether facet information can be returned for the field.
doubleArrayOptions_searchEnabled :: Lens' DoubleArrayOptions (Maybe Bool) Source #
Whether the contents of the field are searchable.
doubleArrayOptions_defaultValue :: Lens' DoubleArrayOptions (Maybe Double) Source #
A value to use for the field if the field isn't specified for a document.
DoubleOptions
data DoubleOptions Source #
Options for a double-precision 64-bit floating point field. Present if
IndexFieldType specifies the field is of type double. All options
are enabled by default.
See: newDoubleOptions smart constructor.
Constructors
| DoubleOptions' | |
Fields
| |
Instances
newDoubleOptions :: DoubleOptions Source #
Create a value of DoubleOptions with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:sourceField:DoubleOptions', doubleOptions_sourceField - The name of the source field to map to the field.
$sel:returnEnabled:DoubleOptions', doubleOptions_returnEnabled - Whether the contents of the field can be returned in the search results.
$sel:facetEnabled:DoubleOptions', doubleOptions_facetEnabled - Whether facet information can be returned for the field.
$sel:searchEnabled:DoubleOptions', doubleOptions_searchEnabled - Whether the contents of the field are searchable.
$sel:sortEnabled:DoubleOptions', doubleOptions_sortEnabled - Whether the field can be used to sort the search results.
$sel:defaultValue:DoubleOptions', doubleOptions_defaultValue - 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.
doubleOptions_sourceField :: Lens' DoubleOptions (Maybe Text) Source #
The name of the source field to map to the field.
doubleOptions_returnEnabled :: Lens' DoubleOptions (Maybe Bool) Source #
Whether the contents of the field can be returned in the search results.
doubleOptions_facetEnabled :: Lens' DoubleOptions (Maybe Bool) Source #
Whether facet information can be returned for the field.
doubleOptions_searchEnabled :: Lens' DoubleOptions (Maybe Bool) Source #
Whether the contents of the field are searchable.
doubleOptions_sortEnabled :: Lens' DoubleOptions (Maybe Bool) Source #
Whether the field can be used to sort the search results.
doubleOptions_defaultValue :: Lens' DoubleOptions (Maybe Double) Source #
A value to use for the field if the field isn't specified for a document. This can be important if you are using the field in an expression and that field is not present in every document.
Expression
data Expression Source #
A named expression that can be evaluated at search time. Can be used to sort the search results, define other expressions, or return computed information in the search results.
See: newExpression smart constructor.
Constructors
| Expression' | |
Fields | |
Instances
Create a value of Expression with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:expressionName:Expression', expression_expressionName - Undocumented member.
$sel:expressionValue:Expression', expression_expressionValue - Undocumented member.
expression_expressionName :: Lens' Expression Text Source #
Undocumented member.
expression_expressionValue :: Lens' Expression Text Source #
Undocumented member.
ExpressionStatus
data ExpressionStatus Source #
The value of an Expression and its current status.
See: newExpressionStatus smart constructor.
Constructors
| ExpressionStatus' | |
Fields
| |
Instances
Arguments
| :: Expression | |
| -> OptionStatus | |
| -> ExpressionStatus |
Create a value of ExpressionStatus with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:options:ExpressionStatus', expressionStatus_options - The expression that is evaluated for sorting while processing a search
request.
$sel:status:ExpressionStatus', expressionStatus_status - Undocumented member.
expressionStatus_options :: Lens' ExpressionStatus Expression Source #
The expression that is evaluated for sorting while processing a search request.
expressionStatus_status :: Lens' ExpressionStatus OptionStatus Source #
Undocumented member.
IndexField
data IndexField Source #
Configuration information for a field in the index, including its name,
type, and options. The supported options depend on the IndexFieldType.
See: newIndexField smart constructor.
Constructors
| IndexField' | |
Fields
| |
Instances
Arguments
| :: Text | |
| -> IndexFieldType | |
| -> IndexField |
Create a value of IndexField with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:doubleArrayOptions:IndexField', indexField_doubleArrayOptions - Undocumented member.
$sel:dateOptions:IndexField', indexField_dateOptions - Undocumented member.
$sel:textArrayOptions:IndexField', indexField_textArrayOptions - Undocumented member.
$sel:doubleOptions:IndexField', indexField_doubleOptions - Undocumented member.
$sel:textOptions:IndexField', indexField_textOptions - Undocumented member.
$sel:latLonOptions:IndexField', indexField_latLonOptions - Undocumented member.
$sel:literalArrayOptions:IndexField', indexField_literalArrayOptions - Undocumented member.
$sel:intArrayOptions:IndexField', indexField_intArrayOptions - Undocumented member.
$sel:dateArrayOptions:IndexField', indexField_dateArrayOptions - Undocumented member.
$sel:intOptions:IndexField', indexField_intOptions - Undocumented member.
$sel:literalOptions:IndexField', indexField_literalOptions - Undocumented member.
$sel:indexFieldName:IndexField', indexField_indexFieldName - 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.
$sel:indexFieldType:IndexField', indexField_indexFieldType - Undocumented member.
indexField_doubleArrayOptions :: Lens' IndexField (Maybe DoubleArrayOptions) Source #
Undocumented member.
indexField_dateOptions :: Lens' IndexField (Maybe DateOptions) Source #
Undocumented member.
indexField_textArrayOptions :: Lens' IndexField (Maybe TextArrayOptions) Source #
Undocumented member.
indexField_doubleOptions :: Lens' IndexField (Maybe DoubleOptions) Source #
Undocumented member.
indexField_textOptions :: Lens' IndexField (Maybe TextOptions) Source #
Undocumented member.
indexField_latLonOptions :: Lens' IndexField (Maybe LatLonOptions) Source #
Undocumented member.
indexField_literalArrayOptions :: Lens' IndexField (Maybe LiteralArrayOptions) Source #
Undocumented member.
indexField_intArrayOptions :: Lens' IndexField (Maybe IntArrayOptions) Source #
Undocumented member.
indexField_dateArrayOptions :: Lens' IndexField (Maybe DateArrayOptions) Source #
Undocumented member.
indexField_intOptions :: Lens' IndexField (Maybe IntOptions) Source #
Undocumented member.
indexField_literalOptions :: Lens' IndexField (Maybe LiteralOptions) Source #
Undocumented member.
indexField_indexFieldName :: Lens' IndexField Text Source #
A string that represents the name of an index field. CloudSearch supports regular index fields as well as dynamic fields. A dynamic field's name defines a pattern that begins or ends with a wildcard. Any document fields that don't map to a regular index field but do match a dynamic field's pattern are configured with the dynamic field's indexing options.
Regular field names begin with a letter and can contain the following characters: a-z (lowercase), 0-9, and _ (underscore). Dynamic field names must begin or end with a wildcard (*). The wildcard can also be the only character in a dynamic field name. Multiple wildcards, and wildcards embedded within a string are not supported.
The name score is reserved and cannot be used as a field name. To
reference a document's ID, you can use the name _id.
indexField_indexFieldType :: Lens' IndexField IndexFieldType Source #
Undocumented member.
IndexFieldStatus
data IndexFieldStatus Source #
The value of an IndexField and its current status.
See: newIndexFieldStatus smart constructor.
Constructors
| IndexFieldStatus' | |
Fields
| |
Instances
Arguments
| :: IndexField | |
| -> OptionStatus | |
| -> IndexFieldStatus |
Create a value of IndexFieldStatus with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:options:IndexFieldStatus', indexFieldStatus_options - Undocumented member.
$sel:status:IndexFieldStatus', indexFieldStatus_status - Undocumented member.
indexFieldStatus_options :: Lens' IndexFieldStatus IndexField Source #
Undocumented member.
indexFieldStatus_status :: Lens' IndexFieldStatus OptionStatus Source #
Undocumented member.
IntArrayOptions
data IntArrayOptions Source #
Options for a field that contains an array of 64-bit signed integers.
Present if IndexFieldType specifies the field is of type int-array.
All options are enabled by default.
See: newIntArrayOptions smart constructor.
Constructors
| IntArrayOptions' | |
Fields
| |
Instances
newIntArrayOptions :: IntArrayOptions Source #
Create a value of IntArrayOptions with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:sourceFields:IntArrayOptions', intArrayOptions_sourceFields - A list of source fields to map to the field.
$sel:returnEnabled:IntArrayOptions', intArrayOptions_returnEnabled - Whether the contents of the field can be returned in the search results.
$sel:facetEnabled:IntArrayOptions', intArrayOptions_facetEnabled - Whether facet information can be returned for the field.
$sel:searchEnabled:IntArrayOptions', intArrayOptions_searchEnabled - Whether the contents of the field are searchable.
$sel:defaultValue:IntArrayOptions', intArrayOptions_defaultValue - A value to use for the field if the field isn't specified for a
document.
intArrayOptions_sourceFields :: Lens' IntArrayOptions (Maybe Text) Source #
A list of source fields to map to the field.
intArrayOptions_returnEnabled :: Lens' IntArrayOptions (Maybe Bool) Source #
Whether the contents of the field can be returned in the search results.
intArrayOptions_facetEnabled :: Lens' IntArrayOptions (Maybe Bool) Source #
Whether facet information can be returned for the field.
intArrayOptions_searchEnabled :: Lens' IntArrayOptions (Maybe Bool) Source #
Whether the contents of the field are searchable.
intArrayOptions_defaultValue :: Lens' IntArrayOptions (Maybe Integer) Source #
A value to use for the field if the field isn't specified for a document.
IntOptions
data IntOptions Source #
Options for a 64-bit signed integer field. Present if IndexFieldType
specifies the field is of type int. All options are enabled by
default.
See: newIntOptions smart constructor.
Constructors
| IntOptions' | |
Fields
| |
Instances
newIntOptions :: IntOptions Source #
Create a value of IntOptions with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:sourceField:IntOptions', intOptions_sourceField - The name of the source field to map to the field.
$sel:returnEnabled:IntOptions', intOptions_returnEnabled - Whether the contents of the field can be returned in the search results.
$sel:facetEnabled:IntOptions', intOptions_facetEnabled - Whether facet information can be returned for the field.
$sel:searchEnabled:IntOptions', intOptions_searchEnabled - Whether the contents of the field are searchable.
$sel:sortEnabled:IntOptions', intOptions_sortEnabled - Whether the field can be used to sort the search results.
$sel:defaultValue:IntOptions', intOptions_defaultValue - 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.
intOptions_sourceField :: Lens' IntOptions (Maybe Text) Source #
The name of the source field to map to the field.
intOptions_returnEnabled :: Lens' IntOptions (Maybe Bool) Source #
Whether the contents of the field can be returned in the search results.
intOptions_facetEnabled :: Lens' IntOptions (Maybe Bool) Source #
Whether facet information can be returned for the field.
intOptions_searchEnabled :: Lens' IntOptions (Maybe Bool) Source #
Whether the contents of the field are searchable.
intOptions_sortEnabled :: Lens' IntOptions (Maybe Bool) Source #
Whether the field can be used to sort the search results.
intOptions_defaultValue :: Lens' IntOptions (Maybe Integer) Source #
A value to use for the field if the field isn't specified for a document. This can be important if you are using the field in an expression and that field is not present in every document.
LatLonOptions
data LatLonOptions Source #
Options for a latlon field. A latlon field contains a location stored as
a latitude and longitude value pair. Present if IndexFieldType
specifies the field is of type latlon. All options are enabled by
default.
See: newLatLonOptions smart constructor.
Constructors
| LatLonOptions' | |
Fields
| |
Instances
newLatLonOptions :: LatLonOptions Source #
Create a value of LatLonOptions with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:sourceField:LatLonOptions', latLonOptions_sourceField - Undocumented member.
$sel:returnEnabled:LatLonOptions', latLonOptions_returnEnabled - Whether the contents of the field can be returned in the search results.
$sel:facetEnabled:LatLonOptions', latLonOptions_facetEnabled - Whether facet information can be returned for the field.
$sel:searchEnabled:LatLonOptions', latLonOptions_searchEnabled - Whether the contents of the field are searchable.
$sel:sortEnabled:LatLonOptions', latLonOptions_sortEnabled - Whether the field can be used to sort the search results.
$sel:defaultValue:LatLonOptions', latLonOptions_defaultValue - A value to use for the field if the field isn't specified for a
document.
latLonOptions_sourceField :: Lens' LatLonOptions (Maybe Text) Source #
Undocumented member.
latLonOptions_returnEnabled :: Lens' LatLonOptions (Maybe Bool) Source #
Whether the contents of the field can be returned in the search results.
latLonOptions_facetEnabled :: Lens' LatLonOptions (Maybe Bool) Source #
Whether facet information can be returned for the field.
latLonOptions_searchEnabled :: Lens' LatLonOptions (Maybe Bool) Source #
Whether the contents of the field are searchable.
latLonOptions_sortEnabled :: Lens' LatLonOptions (Maybe Bool) Source #
Whether the field can be used to sort the search results.
latLonOptions_defaultValue :: Lens' LatLonOptions (Maybe Text) Source #
A value to use for the field if the field isn't specified for a document.
Limits
See: newLimits smart constructor.
Constructors
| Limits' | |
Fields | |
Instances
| Eq Limits Source # | |
| Read Limits Source # | |
| Show Limits Source # | |
| Generic Limits Source # | |
| NFData Limits Source # | |
Defined in Amazonka.CloudSearch.Types.Limits | |
| Hashable Limits Source # | |
Defined in Amazonka.CloudSearch.Types.Limits | |
| FromXML Limits Source # | |
| type Rep Limits Source # | |
Defined in Amazonka.CloudSearch.Types.Limits type Rep Limits = D1 ('MetaData "Limits" "Amazonka.CloudSearch.Types.Limits" "libZSservicesZSamazonka-cloudsearchZSamazonka-cloudsearch" 'False) (C1 ('MetaCons "Limits'" 'PrefixI 'True) (S1 ('MetaSel ('Just "maximumReplicationCount") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Natural) :*: S1 ('MetaSel ('Just "maximumPartitionCount") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Natural))) | |
Create a value of Limits with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:maximumReplicationCount:Limits', limits_maximumReplicationCount - Undocumented member.
$sel:maximumPartitionCount:Limits', limits_maximumPartitionCount - Undocumented member.
LiteralArrayOptions
data LiteralArrayOptions Source #
Options for a field that contains an array of literal strings. Present
if IndexFieldType specifies the field is of type literal-array. All
options are enabled by default.
See: newLiteralArrayOptions smart constructor.
Constructors
| LiteralArrayOptions' | |
Fields
| |
Instances
newLiteralArrayOptions :: LiteralArrayOptions Source #
Create a value of LiteralArrayOptions with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:sourceFields:LiteralArrayOptions', literalArrayOptions_sourceFields - A list of source fields to map to the field.
$sel:returnEnabled:LiteralArrayOptions', literalArrayOptions_returnEnabled - Whether the contents of the field can be returned in the search results.
$sel:facetEnabled:LiteralArrayOptions', literalArrayOptions_facetEnabled - Whether facet information can be returned for the field.
$sel:searchEnabled:LiteralArrayOptions', literalArrayOptions_searchEnabled - Whether the contents of the field are searchable.
$sel:defaultValue:LiteralArrayOptions', literalArrayOptions_defaultValue - A value to use for the field if the field isn't specified for a
document.
literalArrayOptions_sourceFields :: Lens' LiteralArrayOptions (Maybe Text) Source #
A list of source fields to map to the field.
literalArrayOptions_returnEnabled :: Lens' LiteralArrayOptions (Maybe Bool) Source #
Whether the contents of the field can be returned in the search results.
literalArrayOptions_facetEnabled :: Lens' LiteralArrayOptions (Maybe Bool) Source #
Whether facet information can be returned for the field.
literalArrayOptions_searchEnabled :: Lens' LiteralArrayOptions (Maybe Bool) Source #
Whether the contents of the field are searchable.
literalArrayOptions_defaultValue :: Lens' LiteralArrayOptions (Maybe Text) Source #
A value to use for the field if the field isn't specified for a document.
LiteralOptions
data LiteralOptions Source #
Options for literal field. Present if IndexFieldType specifies the
field is of type literal. All options are enabled by default.
See: newLiteralOptions smart constructor.
Constructors
| LiteralOptions' | |
Fields
| |
Instances
newLiteralOptions :: LiteralOptions Source #
Create a value of LiteralOptions with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:sourceField:LiteralOptions', literalOptions_sourceField - Undocumented member.
$sel:returnEnabled:LiteralOptions', literalOptions_returnEnabled - Whether the contents of the field can be returned in the search results.
$sel:facetEnabled:LiteralOptions', literalOptions_facetEnabled - Whether facet information can be returned for the field.
$sel:searchEnabled:LiteralOptions', literalOptions_searchEnabled - Whether the contents of the field are searchable.
$sel:sortEnabled:LiteralOptions', literalOptions_sortEnabled - Whether the field can be used to sort the search results.
$sel:defaultValue:LiteralOptions', literalOptions_defaultValue - A value to use for the field if the field isn't specified for a
document.
literalOptions_sourceField :: Lens' LiteralOptions (Maybe Text) Source #
Undocumented member.
literalOptions_returnEnabled :: Lens' LiteralOptions (Maybe Bool) Source #
Whether the contents of the field can be returned in the search results.
literalOptions_facetEnabled :: Lens' LiteralOptions (Maybe Bool) Source #
Whether facet information can be returned for the field.
literalOptions_searchEnabled :: Lens' LiteralOptions (Maybe Bool) Source #
Whether the contents of the field are searchable.
literalOptions_sortEnabled :: Lens' LiteralOptions (Maybe Bool) Source #
Whether the field can be used to sort the search results.
literalOptions_defaultValue :: Lens' LiteralOptions (Maybe Text) Source #
A value to use for the field if the field isn't specified for a document.
OptionStatus
data OptionStatus Source #
The status of domain configuration option.
See: newOptionStatus smart constructor.
Constructors
| OptionStatus' | |
Fields
| |
Instances
Arguments
| :: UTCTime | |
| -> UTCTime | |
| -> OptionState | |
| -> OptionStatus |
Create a value of OptionStatus with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:pendingDeletion:OptionStatus', optionStatus_pendingDeletion - Indicates that the option will be deleted once processing is complete.
$sel:updateVersion:OptionStatus', optionStatus_updateVersion - A unique integer that indicates when this option was last updated.
$sel:creationDate:OptionStatus', optionStatus_creationDate - A timestamp for when this option was created.
$sel:updateDate:OptionStatus', optionStatus_updateDate - A timestamp for when this option was last updated.
$sel:state:OptionStatus', optionStatus_state - The state of processing a change to an option. Possible values:
RequiresIndexDocuments: the option's latest value will not be deployed until IndexDocuments has been called and indexing is complete.Processing: the option's latest value is in the process of being activated.Active: the option's latest value is completely deployed.FailedToValidate: the option value is not compatible with the domain's data and cannot be used to index the data. You must either modify the option value or update or remove the incompatible documents.
optionStatus_pendingDeletion :: Lens' OptionStatus (Maybe Bool) Source #
Indicates that the option will be deleted once processing is complete.
optionStatus_updateVersion :: Lens' OptionStatus (Maybe Natural) Source #
A unique integer that indicates when this option was last updated.
optionStatus_creationDate :: Lens' OptionStatus UTCTime Source #
A timestamp for when this option was created.
optionStatus_updateDate :: Lens' OptionStatus UTCTime Source #
A timestamp for when this option was last updated.
optionStatus_state :: Lens' OptionStatus OptionState Source #
The state of processing a change to an option. Possible values:
RequiresIndexDocuments: the option's latest value will not be deployed until IndexDocuments has been called and indexing is complete.Processing: the option's latest value is in the process of being activated.Active: the option's latest value is completely deployed.FailedToValidate: the option value is not compatible with the domain's data and cannot be used to index the data. You must either modify the option value or update or remove the incompatible documents.
ScalingParameters
data ScalingParameters Source #
The desired instance type and desired number of replicas of each index partition.
See: newScalingParameters smart constructor.
Constructors
| ScalingParameters' | |
Fields
| |
Instances
newScalingParameters :: ScalingParameters Source #
Create a value of ScalingParameters with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:desiredInstanceType:ScalingParameters', scalingParameters_desiredInstanceType - The instance type that you want to preconfigure for your domain. For
example, search.m1.small.
$sel:desiredReplicationCount:ScalingParameters', scalingParameters_desiredReplicationCount - The number of replicas you want to preconfigure for each index
partition.
$sel:desiredPartitionCount:ScalingParameters', scalingParameters_desiredPartitionCount - The number of partitions you want to preconfigure for your domain. Only
valid when you select m2.2xlarge as the desired instance type.
scalingParameters_desiredInstanceType :: Lens' ScalingParameters (Maybe PartitionInstanceType) Source #
The instance type that you want to preconfigure for your domain. For
example, search.m1.small.
scalingParameters_desiredReplicationCount :: Lens' ScalingParameters (Maybe Natural) Source #
The number of replicas you want to preconfigure for each index partition.
scalingParameters_desiredPartitionCount :: Lens' ScalingParameters (Maybe Natural) Source #
The number of partitions you want to preconfigure for your domain. Only
valid when you select m2.2xlarge as the desired instance type.
ScalingParametersStatus
data ScalingParametersStatus Source #
The status and configuration of a search domain's scaling parameters.
See: newScalingParametersStatus smart constructor.
Constructors
| ScalingParametersStatus' | |
Fields | |
Instances
newScalingParametersStatus Source #
Arguments
| :: ScalingParameters | |
| -> OptionStatus | |
| -> ScalingParametersStatus |
Create a value of ScalingParametersStatus with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:options:ScalingParametersStatus', scalingParametersStatus_options - Undocumented member.
$sel:status:ScalingParametersStatus', scalingParametersStatus_status - Undocumented member.
scalingParametersStatus_options :: Lens' ScalingParametersStatus ScalingParameters Source #
Undocumented member.
scalingParametersStatus_status :: Lens' ScalingParametersStatus OptionStatus Source #
Undocumented member.
ServiceEndpoint
data ServiceEndpoint Source #
The endpoint to which service requests can be submitted.
See: newServiceEndpoint smart constructor.
Constructors
| ServiceEndpoint' | |
Instances
newServiceEndpoint :: ServiceEndpoint Source #
Create a value of ServiceEndpoint with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:endpoint:ServiceEndpoint', serviceEndpoint_endpoint - Undocumented member.
serviceEndpoint_endpoint :: Lens' ServiceEndpoint (Maybe Text) Source #
Undocumented member.
Suggester
Configuration information for a search suggester. Each suggester has a
unique name and specifies the text field you want to use for
suggestions. The following options can be configured for a suggester:
FuzzyMatching, SortExpression.
See: newSuggester smart constructor.
Constructors
| Suggester' | |
Instances
| Eq Suggester Source # | |
| Read Suggester Source # | |
| Show Suggester Source # | |
| Generic Suggester Source # | |
| NFData Suggester Source # | |
Defined in Amazonka.CloudSearch.Types.Suggester | |
| Hashable Suggester Source # | |
Defined in Amazonka.CloudSearch.Types.Suggester | |
| ToQuery Suggester Source # | |
Defined in Amazonka.CloudSearch.Types.Suggester Methods toQuery :: Suggester -> QueryString # | |
| FromXML Suggester Source # | |
| type Rep Suggester Source # | |
Defined in Amazonka.CloudSearch.Types.Suggester type Rep Suggester = D1 ('MetaData "Suggester" "Amazonka.CloudSearch.Types.Suggester" "libZSservicesZSamazonka-cloudsearchZSamazonka-cloudsearch" 'False) (C1 ('MetaCons "Suggester'" 'PrefixI 'True) (S1 ('MetaSel ('Just "suggesterName") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Text) :*: S1 ('MetaSel ('Just "documentSuggesterOptions") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 DocumentSuggesterOptions))) | |
Arguments
| :: Text | |
| -> DocumentSuggesterOptions | |
| -> Suggester |
Create a value of Suggester with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:suggesterName:Suggester', suggester_suggesterName - Undocumented member.
$sel:documentSuggesterOptions:Suggester', suggester_documentSuggesterOptions - Undocumented member.
suggester_documentSuggesterOptions :: Lens' Suggester DocumentSuggesterOptions Source #
Undocumented member.
SuggesterStatus
data SuggesterStatus Source #
The value of a Suggester and its current status.
See: newSuggesterStatus smart constructor.
Constructors
| SuggesterStatus' | |
Fields
| |
Instances
Arguments
| :: Suggester | |
| -> OptionStatus | |
| -> SuggesterStatus |
Create a value of SuggesterStatus with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:options:SuggesterStatus', suggesterStatus_options - Undocumented member.
$sel:status:SuggesterStatus', suggesterStatus_status - Undocumented member.
suggesterStatus_options :: Lens' SuggesterStatus Suggester Source #
Undocumented member.
suggesterStatus_status :: Lens' SuggesterStatus OptionStatus Source #
Undocumented member.
TextArrayOptions
data TextArrayOptions Source #
Options for a field that contains an array of text strings. Present if
IndexFieldType specifies the field is of type text-array. A
text-array field is always searchable. All options are enabled by
default.
See: newTextArrayOptions smart constructor.
Constructors
| TextArrayOptions' | |
Fields
| |
Instances
newTextArrayOptions :: TextArrayOptions Source #
Create a value of TextArrayOptions with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:sourceFields:TextArrayOptions', textArrayOptions_sourceFields - A list of source fields to map to the field.
$sel:returnEnabled:TextArrayOptions', textArrayOptions_returnEnabled - Whether the contents of the field can be returned in the search results.
$sel:analysisScheme:TextArrayOptions', textArrayOptions_analysisScheme - The name of an analysis scheme for a text-array field.
$sel:highlightEnabled:TextArrayOptions', textArrayOptions_highlightEnabled - Whether highlights can be returned for the field.
$sel:defaultValue:TextArrayOptions', textArrayOptions_defaultValue - A value to use for the field if the field isn't specified for a
document.
textArrayOptions_sourceFields :: Lens' TextArrayOptions (Maybe Text) Source #
A list of source fields to map to the field.
textArrayOptions_returnEnabled :: Lens' TextArrayOptions (Maybe Bool) Source #
Whether the contents of the field can be returned in the search results.
textArrayOptions_analysisScheme :: Lens' TextArrayOptions (Maybe Text) Source #
The name of an analysis scheme for a text-array field.
textArrayOptions_highlightEnabled :: Lens' TextArrayOptions (Maybe Bool) Source #
Whether highlights can be returned for the field.
textArrayOptions_defaultValue :: Lens' TextArrayOptions (Maybe Text) Source #
A value to use for the field if the field isn't specified for a document.
TextOptions
data TextOptions Source #
Options for text field. Present if IndexFieldType specifies the field
is of type text. A text field is always searchable. All options are
enabled by default.
See: newTextOptions smart constructor.
Constructors
| TextOptions' | |
Fields
| |
Instances
newTextOptions :: TextOptions Source #
Create a value of TextOptions with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:sourceField:TextOptions', textOptions_sourceField - Undocumented member.
$sel:returnEnabled:TextOptions', textOptions_returnEnabled - Whether the contents of the field can be returned in the search results.
$sel:analysisScheme:TextOptions', textOptions_analysisScheme - The name of an analysis scheme for a text field.
$sel:highlightEnabled:TextOptions', textOptions_highlightEnabled - Whether highlights can be returned for the field.
$sel:sortEnabled:TextOptions', textOptions_sortEnabled - Whether the field can be used to sort the search results.
$sel:defaultValue:TextOptions', textOptions_defaultValue - A value to use for the field if the field isn't specified for a
document.
textOptions_sourceField :: Lens' TextOptions (Maybe Text) Source #
Undocumented member.
textOptions_returnEnabled :: Lens' TextOptions (Maybe Bool) Source #
Whether the contents of the field can be returned in the search results.
textOptions_analysisScheme :: Lens' TextOptions (Maybe Text) Source #
The name of an analysis scheme for a text field.
textOptions_highlightEnabled :: Lens' TextOptions (Maybe Bool) Source #
Whether highlights can be returned for the field.
textOptions_sortEnabled :: Lens' TextOptions (Maybe Bool) Source #
Whether the field can be used to sort the search results.
textOptions_defaultValue :: Lens' TextOptions (Maybe Text) Source #
A value to use for the field if the field isn't specified for a document.