amazonka-cloudsearch 1.4.4 → 1.4.5
raw patch · 30 files changed
+616/−415 lines, 30 filesdep ~amazonka-cloudsearchdep ~amazonka-coredep ~amazonka-testPVP ok
version bump matches the API change (PVP)
Dependency ranges changed: amazonka-cloudsearch, amazonka-core, amazonka-test
API changes (from Hackage documentation)
Files
- README.md +9/−10
- amazonka-cloudsearch.cabal +10/−15
- gen/Network/AWS/CloudSearch.hs +3/−2
- gen/Network/AWS/CloudSearch/BuildSuggesters.hs +13/−7
- gen/Network/AWS/CloudSearch/CreateDomain.hs +13/−7
- gen/Network/AWS/CloudSearch/DefineAnalysisScheme.hs +14/−8
- gen/Network/AWS/CloudSearch/DefineExpression.hs +14/−8
- gen/Network/AWS/CloudSearch/DefineIndexField.hs +14/−8
- gen/Network/AWS/CloudSearch/DefineSuggester.hs +14/−8
- gen/Network/AWS/CloudSearch/DeleteAnalysisScheme.hs +14/−8
- gen/Network/AWS/CloudSearch/DeleteDomain.hs +13/−7
- gen/Network/AWS/CloudSearch/DeleteExpression.hs +15/−9
- gen/Network/AWS/CloudSearch/DeleteIndexField.hs +15/−9
- gen/Network/AWS/CloudSearch/DeleteSuggester.hs +14/−8
- gen/Network/AWS/CloudSearch/DescribeAnalysisSchemes.hs +16/−10
- gen/Network/AWS/CloudSearch/DescribeAvailabilityOptions.hs +15/−9
- gen/Network/AWS/CloudSearch/DescribeDomains.hs +13/−7
- gen/Network/AWS/CloudSearch/DescribeExpressions.hs +17/−11
- gen/Network/AWS/CloudSearch/DescribeIndexFields.hs +16/−10
- gen/Network/AWS/CloudSearch/DescribeScalingParameters.hs +13/−7
- gen/Network/AWS/CloudSearch/DescribeServiceAccessPolicies.hs +15/−9
- gen/Network/AWS/CloudSearch/DescribeSuggesters.hs +16/−10
- gen/Network/AWS/CloudSearch/IndexDocuments.hs +13/−7
- gen/Network/AWS/CloudSearch/ListDomainNames.hs +8/−4
- gen/Network/AWS/CloudSearch/Types.hs +14/−2
- gen/Network/AWS/CloudSearch/Types/Product.hs +230/−183
- gen/Network/AWS/CloudSearch/Types/Sum.hs +12/−7
- gen/Network/AWS/CloudSearch/UpdateAvailabilityOptions.hs +15/−9
- gen/Network/AWS/CloudSearch/UpdateScalingParameters.hs +14/−8
- gen/Network/AWS/CloudSearch/UpdateServiceAccessPolicies.hs +14/−8
README.md view
@@ -8,28 +8,27 @@ ## Version -`1.4.4`+`1.4.5` ## Description -Amazon CloudSearch Configuration Service--You use the Amazon CloudSearch configuration service to create, configure, and manage search domains. Configuration service requests are submitted using the AWS Query protocol. AWS Query requests are HTTP or HTTPS requests submitted via HTTP GET or POST with a query parameter named Action.--The endpoint for configuration service requests is region-specific: cloudsearch./region/.amazonaws.com. For example, cloudsearch.us-east-1.amazonaws.com. For a current list of supported regions and endpoints, see <http://docs.aws.amazon.com/general/latest/gr/rande.html#cloudsearch_region Regions and Endpoints>.- Documentation is available via [Hackage](http://hackage.haskell.org/package/amazonka-cloudsearch) and the [AWS API Reference](https://aws.amazon.com/documentation/). The types from this library are intended to be used with [amazonka](http://hackage.haskell.org/package/amazonka),-which provides mechanisms for specifying AuthN/AuthZ information and sending requests.+which provides mechanisms for specifying AuthN/AuthZ information, sending requests,+and receiving responses. -Use of lenses is required for constructing and manipulating types.-This is due to the amount of nesting of AWS types and transparency regarding+Lenses are used for constructing and manipulating types,+due to the depth of nesting of AWS types and transparency regarding de/serialisation into more palatable Haskell values. The provided lenses should be compatible with any of the major lens libraries [lens](http://hackage.haskell.org/package/lens) or [lens-family-core](http://hackage.haskell.org/package/lens-family-core).++See [Network.AWS.CloudSearch](http://hackage.haskell.org/package/amazonka-cloudsearch/docs/Network-AWS-CloudSearch.html)+or [the AWS documentation](https://aws.amazon.com/documentation/) to get started.+ ## Contribute
amazonka-cloudsearch.cabal view
@@ -1,5 +1,5 @@ name: amazonka-cloudsearch-version: 1.4.4+version: 1.4.5 synopsis: Amazon CloudSearch SDK. homepage: https://github.com/brendanhay/amazonka bug-reports: https://github.com/brendanhay/amazonka/issues@@ -13,24 +13,19 @@ cabal-version: >= 1.10 extra-source-files: README.md fixture/*.yaml fixture/*.proto src/.gitkeep description:- Amazon CloudSearch Configuration Service-- You use the Amazon CloudSearch configuration service to create, configure, and manage search domains. Configuration service requests are submitted using the AWS Query protocol. AWS Query requests are HTTP or HTTPS requests submitted via HTTP GET or POST with a query parameter named Action.-- The endpoint for configuration service requests is region-specific: cloudsearch./region/.amazonaws.com. For example, cloudsearch.us-east-1.amazonaws.com. For a current list of supported regions and endpoints, see <http://docs.aws.amazon.com/general/latest/gr/rande.html#cloudsearch_region Regions and Endpoints>.- . The types from this library are intended to be used with <http://hackage.haskell.org/package/amazonka amazonka>, which provides- mechanisms for specifying AuthN/AuthZ information and sending requests.+ mechanisms for specifying AuthN/AuthZ information, sending requests,+ and receiving responses. .- Use of lenses is required for constructing and manipulating types.- This is due to the amount of nesting of AWS types and transparency regarding+ Lenses are used for constructing and manipulating types,+ due to the depth of nesting of AWS types and transparency regarding de/serialisation into more palatable Haskell values. The provided lenses should be compatible with any of the major lens libraries such as <http://hackage.haskell.org/package/lens lens> or <http://hackage.haskell.org/package/lens-family-core lens-family-core>. .- See "Network.AWS.CloudSearch" or <https://aws.amazon.com/documentation/ the AWS Documentation>+ See "Network.AWS.CloudSearch" or <https://aws.amazon.com/documentation/ the AWS documentation> to get started. source-repository head@@ -77,7 +72,7 @@ , Network.AWS.CloudSearch.Types.Sum build-depends:- amazonka-core == 1.4.4.*+ amazonka-core == 1.4.5.* , base >= 4.7 && < 5 test-suite amazonka-cloudsearch-test@@ -97,9 +92,9 @@ , Test.AWS.CloudSearch.Internal build-depends:- amazonka-core == 1.4.4.*- , amazonka-test == 1.4.4.*- , amazonka-cloudsearch == 1.4.4.*+ amazonka-core == 1.4.5.*+ , amazonka-test == 1.4.5.*+ , amazonka-cloudsearch == 1.4.5.* , base , bytestring , tasty
gen/Network/AWS/CloudSearch.hs view
@@ -11,11 +11,12 @@ -- Stability : auto-generated -- Portability : non-portable (GHC extensions) ----- Amazon CloudSearch Configuration Service+-- __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 <http://docs.aws.amazon.com/general/latest/gr/rande.html#cloudsearch_region Regions and Endpoints>.+-- 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 <http://docs.aws.amazon.com/general/latest/gr/rande.html#cloudsearch_region Regions and Endpoints> .+-- module Network.AWS.CloudSearch ( -- * Service Configuration
gen/Network/AWS/CloudSearch/BuildSuggesters.hs view
@@ -18,7 +18,9 @@ -- Stability : auto-generated -- Portability : non-portable (GHC extensions) ----- Indexes the search suggestions. For more information, see <http://docs.aws.amazon.com/cloudsearch/latest/developerguide/getting-suggestions.html#configuring-suggesters Configuring Suggesters> in the /Amazon CloudSearch Developer Guide/.+-- Indexes the search suggestions. For more information, see <http://docs.aws.amazon.com/cloudsearch/latest/developerguide/getting-suggestions.html#configuring-suggesters Configuring Suggesters> in the /Amazon CloudSearch Developer Guide/ .+--+-- module Network.AWS.CloudSearch.BuildSuggesters ( -- * Creating a Request@@ -42,8 +44,10 @@ import Network.AWS.Request import Network.AWS.Response --- | Container for the parameters to the 'BuildSuggester' operation. Specifies the name of the domain you want to update.+-- | Container for the parameters to the @'BuildSuggester' @ operation. Specifies the name of the domain you want to update. --+--+-- -- /See:/ 'buildSuggesters' smart constructor. newtype BuildSuggesters = BuildSuggesters' { _bsDomainName :: Text@@ -53,7 +57,7 @@ -- -- Use one of the following lenses to modify other fields as desired: ----- * 'bsDomainName'+-- * 'bsDomainName' - Undocumented member. buildSuggesters :: Text -- ^ 'bsDomainName' -> BuildSuggesters@@ -94,8 +98,10 @@ "Version" =: ("2013-01-01" :: ByteString), "DomainName" =: _bsDomainName] --- | The result of a 'BuildSuggester' request. Contains a list of the fields used for suggestions.+-- | The result of a @BuildSuggester@ request. Contains a list of the fields used for suggestions. --+--+-- -- /See:/ 'buildSuggestersResponse' smart constructor. data BuildSuggestersResponse = BuildSuggestersResponse' { _bsrsFieldNames :: !(Maybe [Text])@@ -106,9 +112,9 @@ -- -- Use one of the following lenses to modify other fields as desired: ----- * 'bsrsFieldNames'+-- * 'bsrsFieldNames' - Undocumented member. ----- * 'bsrsResponseStatus'+-- * 'bsrsResponseStatus' - -- | The response status code. buildSuggestersResponse :: Int -- ^ 'bsrsResponseStatus' -> BuildSuggestersResponse@@ -122,7 +128,7 @@ bsrsFieldNames :: Lens' BuildSuggestersResponse [Text] bsrsFieldNames = lens _bsrsFieldNames (\ s a -> s{_bsrsFieldNames = a}) . _Default . _Coerce; --- | The response status code.+-- | -- | The response status code. bsrsResponseStatus :: Lens' BuildSuggestersResponse Int bsrsResponseStatus = lens _bsrsResponseStatus (\ s a -> s{_bsrsResponseStatus = a});
gen/Network/AWS/CloudSearch/CreateDomain.hs view
@@ -18,7 +18,9 @@ -- Stability : auto-generated -- Portability : non-portable (GHC extensions) ----- Creates a new search domain. For more information, see <http://docs.aws.amazon.com/cloudsearch/latest/developerguide/creating-domains.html Creating a Search Domain> in the /Amazon CloudSearch Developer Guide/.+-- Creates a new search domain. For more information, see <http://docs.aws.amazon.com/cloudsearch/latest/developerguide/creating-domains.html Creating a Search Domain> in the /Amazon CloudSearch Developer Guide/ .+--+-- module Network.AWS.CloudSearch.CreateDomain ( -- * Creating a Request@@ -42,8 +44,10 @@ import Network.AWS.Request import Network.AWS.Response --- | Container for the parameters to the 'CreateDomain' operation. Specifies a name for the new search domain.+-- | Container for the parameters to the @'CreateDomain' @ operation. Specifies a name for the new search domain. --+--+-- -- /See:/ 'createDomain' smart constructor. newtype CreateDomain = CreateDomain' { _cdDomainName :: Text@@ -53,7 +57,7 @@ -- -- Use one of the following lenses to modify other fields as desired: ----- * 'cdDomainName'+-- * 'cdDomainName' - 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. createDomain :: Text -- ^ 'cdDomainName' -> CreateDomain@@ -92,8 +96,10 @@ "Version" =: ("2013-01-01" :: ByteString), "DomainName" =: _cdDomainName] --- | The result of a 'CreateDomainRequest'. Contains the status of a newly created domain.+-- | The result of a @CreateDomainRequest@ . Contains the status of a newly created domain. --+--+-- -- /See:/ 'createDomainResponse' smart constructor. data CreateDomainResponse = CreateDomainResponse' { _cdrsDomainStatus :: !(Maybe DomainStatus)@@ -104,9 +110,9 @@ -- -- Use one of the following lenses to modify other fields as desired: ----- * 'cdrsDomainStatus'+-- * 'cdrsDomainStatus' - Undocumented member. ----- * 'cdrsResponseStatus'+-- * 'cdrsResponseStatus' - -- | The response status code. createDomainResponse :: Int -- ^ 'cdrsResponseStatus' -> CreateDomainResponse@@ -120,7 +126,7 @@ cdrsDomainStatus :: Lens' CreateDomainResponse (Maybe DomainStatus) cdrsDomainStatus = lens _cdrsDomainStatus (\ s a -> s{_cdrsDomainStatus = a}); --- | The response status code.+-- | -- | The response status code. cdrsResponseStatus :: Lens' CreateDomainResponse Int cdrsResponseStatus = lens _cdrsResponseStatus (\ s a -> s{_cdrsResponseStatus = a});
gen/Network/AWS/CloudSearch/DefineAnalysisScheme.hs view
@@ -18,7 +18,9 @@ -- Stability : auto-generated -- Portability : non-portable (GHC extensions) ----- 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 <http://docs.aws.amazon.com/cloudsearch/latest/developerguide/configuring-analysis-schemes.html Configuring Analysis Schemes> in the /Amazon CloudSearch Developer Guide/.+-- 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 <http://docs.aws.amazon.com/cloudsearch/latest/developerguide/configuring-analysis-schemes.html Configuring Analysis Schemes> in the /Amazon CloudSearch Developer Guide/ .+--+-- module Network.AWS.CloudSearch.DefineAnalysisScheme ( -- * Creating a Request@@ -43,8 +45,10 @@ import Network.AWS.Request import Network.AWS.Response --- | Container for the parameters to the 'DefineAnalysisScheme' operation. Specifies the name of the domain you want to update and the analysis scheme configuration.+-- | 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 = DefineAnalysisScheme' { _dasaDomainName :: !Text@@ -55,9 +59,9 @@ -- -- Use one of the following lenses to modify other fields as desired: ----- * 'dasaDomainName'+-- * 'dasaDomainName' - Undocumented member. ----- * 'dasaAnalysisScheme'+-- * 'dasaAnalysisScheme' - Undocumented member. defineAnalysisScheme :: Text -- ^ 'dasaDomainName' -> AnalysisScheme -- ^ 'dasaAnalysisScheme'@@ -104,8 +108,10 @@ "DomainName" =: _dasaDomainName, "AnalysisScheme" =: _dasaAnalysisScheme] --- | The result of a 'DefineAnalysisScheme' request. Contains the status of the newly-configured analysis scheme.+-- | The result of a @'DefineAnalysisScheme' @ request. Contains the status of the newly-configured analysis scheme. --+--+-- -- /See:/ 'defineAnalysisSchemeResponse' smart constructor. data DefineAnalysisSchemeResponse = DefineAnalysisSchemeResponse' { _defersResponseStatus :: !Int@@ -116,9 +122,9 @@ -- -- Use one of the following lenses to modify other fields as desired: ----- * 'defersResponseStatus'+-- * 'defersResponseStatus' - -- | The response status code. ----- * 'defersAnalysisScheme'+-- * 'defersAnalysisScheme' - Undocumented member. defineAnalysisSchemeResponse :: Int -- ^ 'defersResponseStatus' -> AnalysisSchemeStatus -- ^ 'defersAnalysisScheme'@@ -129,7 +135,7 @@ , _defersAnalysisScheme = pAnalysisScheme_ } --- | The response status code.+-- | -- | The response status code. defersResponseStatus :: Lens' DefineAnalysisSchemeResponse Int defersResponseStatus = lens _defersResponseStatus (\ s a -> s{_defersResponseStatus = a});
gen/Network/AWS/CloudSearch/DefineExpression.hs view
@@ -18,7 +18,9 @@ -- Stability : auto-generated -- Portability : non-portable (GHC extensions) ----- 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 <http://docs.aws.amazon.com/cloudsearch/latest/developerguide/configuring-expressions.html Configuring Expressions> in the /Amazon CloudSearch Developer Guide/.+-- 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 <http://docs.aws.amazon.com/cloudsearch/latest/developerguide/configuring-expressions.html Configuring Expressions> in the /Amazon CloudSearch Developer Guide/ .+--+-- module Network.AWS.CloudSearch.DefineExpression ( -- * Creating a Request@@ -43,8 +45,10 @@ import Network.AWS.Request import Network.AWS.Response --- | 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.+-- | 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 = DefineExpression' { _dDomainName :: !Text@@ -55,9 +59,9 @@ -- -- Use one of the following lenses to modify other fields as desired: ----- * 'dDomainName'+-- * 'dDomainName' - Undocumented member. ----- * 'dExpression'+-- * 'dExpression' - Undocumented member. defineExpression :: Text -- ^ 'dDomainName' -> Expression -- ^ 'dExpression'@@ -103,8 +107,10 @@ "DomainName" =: _dDomainName, "Expression" =: _dExpression] --- | The result of a 'DefineExpression' request. Contains the status of the newly-configured expression.+-- | The result of a @DefineExpression@ request. Contains the status of the newly-configured expression. --+--+-- -- /See:/ 'defineExpressionResponse' smart constructor. data DefineExpressionResponse = DefineExpressionResponse' { _dersResponseStatus :: !Int@@ -115,9 +121,9 @@ -- -- Use one of the following lenses to modify other fields as desired: ----- * 'dersResponseStatus'+-- * 'dersResponseStatus' - -- | The response status code. ----- * 'dersExpression'+-- * 'dersExpression' - Undocumented member. defineExpressionResponse :: Int -- ^ 'dersResponseStatus' -> ExpressionStatus -- ^ 'dersExpression'@@ -128,7 +134,7 @@ , _dersExpression = pExpression_ } --- | The response status code.+-- | -- | The response status code. dersResponseStatus :: Lens' DefineExpressionResponse Int dersResponseStatus = lens _dersResponseStatus (\ s a -> s{_dersResponseStatus = a});
gen/Network/AWS/CloudSearch/DefineIndexField.hs view
@@ -18,7 +18,9 @@ -- Stability : auto-generated -- Portability : non-portable (GHC extensions) ----- 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 <http://docs.aws.amazon.com/cloudsearch/latest/developerguide/configuring-index-fields.html Configuring Index Fields> in the /Amazon CloudSearch Developer Guide/.+-- 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 <http://docs.aws.amazon.com/cloudsearch/latest/developerguide/configuring-index-fields.html Configuring Index Fields> in the /Amazon CloudSearch Developer Guide/ .+--+-- module Network.AWS.CloudSearch.DefineIndexField ( -- * Creating a Request@@ -43,8 +45,10 @@ import Network.AWS.Request import Network.AWS.Response --- | Container for the parameters to the 'DefineIndexField' operation. Specifies the name of the domain you want to update and the index field configuration.+-- | 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 = DefineIndexField' { _defeDomainName :: !Text@@ -55,9 +59,9 @@ -- -- Use one of the following lenses to modify other fields as desired: ----- * 'defeDomainName'+-- * 'defeDomainName' - Undocumented member. ----- * 'defeIndexField'+-- * 'defeIndexField' - The index field and field options you want to configure. defineIndexField :: Text -- ^ 'defeDomainName' -> IndexField -- ^ 'defeIndexField'@@ -103,8 +107,10 @@ "DomainName" =: _defeDomainName, "IndexField" =: _defeIndexField] --- | The result of a 'DefineIndexField' request. Contains the status of the newly-configured index field.+-- | The result of a @'DefineIndexField' @ request. Contains the status of the newly-configured index field. --+--+-- -- /See:/ 'defineIndexFieldResponse' smart constructor. data DefineIndexFieldResponse = DefineIndexFieldResponse' { _defrsResponseStatus :: !Int@@ -115,9 +121,9 @@ -- -- Use one of the following lenses to modify other fields as desired: ----- * 'defrsResponseStatus'+-- * 'defrsResponseStatus' - -- | The response status code. ----- * 'defrsIndexField'+-- * 'defrsIndexField' - Undocumented member. defineIndexFieldResponse :: Int -- ^ 'defrsResponseStatus' -> IndexFieldStatus -- ^ 'defrsIndexField'@@ -128,7 +134,7 @@ , _defrsIndexField = pIndexField_ } --- | The response status code.+-- | -- | The response status code. defrsResponseStatus :: Lens' DefineIndexFieldResponse Int defrsResponseStatus = lens _defrsResponseStatus (\ s a -> s{_defrsResponseStatus = a});
gen/Network/AWS/CloudSearch/DefineSuggester.hs view
@@ -18,7 +18,9 @@ -- Stability : auto-generated -- Portability : non-portable (GHC extensions) ----- 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 <http://docs.aws.amazon.com/cloudsearch/latest/developerguide/getting-suggestions.html Getting Search Suggestions> in the /Amazon CloudSearch Developer Guide/.+-- 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 <http://docs.aws.amazon.com/cloudsearch/latest/developerguide/getting-suggestions.html Getting Search Suggestions> in the /Amazon CloudSearch Developer Guide/ .+--+-- module Network.AWS.CloudSearch.DefineSuggester ( -- * Creating a Request@@ -43,8 +45,10 @@ import Network.AWS.Request import Network.AWS.Response --- | Container for the parameters to the 'DefineSuggester' operation. Specifies the name of the domain you want to update and the suggester configuration.+-- | 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 = DefineSuggester' { _defDomainName :: !Text@@ -55,9 +59,9 @@ -- -- Use one of the following lenses to modify other fields as desired: ----- * 'defDomainName'+-- * 'defDomainName' - Undocumented member. ----- * 'defSuggester'+-- * 'defSuggester' - Undocumented member. defineSuggester :: Text -- ^ 'defDomainName' -> Suggester -- ^ 'defSuggester'@@ -103,8 +107,10 @@ "DomainName" =: _defDomainName, "Suggester" =: _defSuggester] --- | The result of a 'DefineSuggester' request. Contains the status of the newly-configured suggester.+-- | The result of a @DefineSuggester@ request. Contains the status of the newly-configured suggester. --+--+-- -- /See:/ 'defineSuggesterResponse' smart constructor. data DefineSuggesterResponse = DefineSuggesterResponse' { _dsrsResponseStatus :: !Int@@ -115,9 +121,9 @@ -- -- Use one of the following lenses to modify other fields as desired: ----- * 'dsrsResponseStatus'+-- * 'dsrsResponseStatus' - -- | The response status code. ----- * 'dsrsSuggester'+-- * 'dsrsSuggester' - Undocumented member. defineSuggesterResponse :: Int -- ^ 'dsrsResponseStatus' -> SuggesterStatus -- ^ 'dsrsSuggester'@@ -128,7 +134,7 @@ , _dsrsSuggester = pSuggester_ } --- | The response status code.+-- | -- | The response status code. dsrsResponseStatus :: Lens' DefineSuggesterResponse Int dsrsResponseStatus = lens _dsrsResponseStatus (\ s a -> s{_dsrsResponseStatus = a});
gen/Network/AWS/CloudSearch/DeleteAnalysisScheme.hs view
@@ -18,7 +18,9 @@ -- Stability : auto-generated -- Portability : non-portable (GHC extensions) ----- Deletes an analysis scheme. For more information, see <http://docs.aws.amazon.com/cloudsearch/latest/developerguide/configuring-analysis-schemes.html Configuring Analysis Schemes> in the /Amazon CloudSearch Developer Guide/.+-- Deletes an analysis scheme. For more information, see <http://docs.aws.amazon.com/cloudsearch/latest/developerguide/configuring-analysis-schemes.html Configuring Analysis Schemes> in the /Amazon CloudSearch Developer Guide/ .+--+-- module Network.AWS.CloudSearch.DeleteAnalysisScheme ( -- * Creating a Request@@ -43,8 +45,10 @@ import Network.AWS.Request import Network.AWS.Response --- | 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.+-- | 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 = DeleteAnalysisScheme' { _dasDomainName :: !Text@@ -55,9 +59,9 @@ -- -- Use one of the following lenses to modify other fields as desired: ----- * 'dasDomainName'+-- * 'dasDomainName' - Undocumented member. ----- * 'dasAnalysisSchemeName'+-- * 'dasAnalysisSchemeName' - The name of the analysis scheme you want to delete. deleteAnalysisScheme :: Text -- ^ 'dasDomainName' -> Text -- ^ 'dasAnalysisSchemeName'@@ -104,8 +108,10 @@ "DomainName" =: _dasDomainName, "AnalysisSchemeName" =: _dasAnalysisSchemeName] --- | The result of a 'DeleteAnalysisScheme' request. Contains the status of the deleted analysis scheme.+-- | The result of a @DeleteAnalysisScheme@ request. Contains the status of the deleted analysis scheme. --+--+-- -- /See:/ 'deleteAnalysisSchemeResponse' smart constructor. data DeleteAnalysisSchemeResponse = DeleteAnalysisSchemeResponse' { _dasarsResponseStatus :: !Int@@ -116,9 +122,9 @@ -- -- Use one of the following lenses to modify other fields as desired: ----- * 'dasarsResponseStatus'+-- * 'dasarsResponseStatus' - -- | The response status code. ----- * 'dasarsAnalysisScheme'+-- * 'dasarsAnalysisScheme' - The status of the analysis scheme being deleted. deleteAnalysisSchemeResponse :: Int -- ^ 'dasarsResponseStatus' -> AnalysisSchemeStatus -- ^ 'dasarsAnalysisScheme'@@ -129,7 +135,7 @@ , _dasarsAnalysisScheme = pAnalysisScheme_ } --- | The response status code.+-- | -- | The response status code. dasarsResponseStatus :: Lens' DeleteAnalysisSchemeResponse Int dasarsResponseStatus = lens _dasarsResponseStatus (\ s a -> s{_dasarsResponseStatus = a});
gen/Network/AWS/CloudSearch/DeleteDomain.hs view
@@ -18,7 +18,9 @@ -- Stability : auto-generated -- Portability : non-portable (GHC extensions) ----- Permanently deletes a search domain and all of its data. Once a domain has been deleted, it cannot be recovered. For more information, see <http://docs.aws.amazon.com/cloudsearch/latest/developerguide/deleting-domains.html Deleting a Search Domain> in the /Amazon CloudSearch Developer Guide/.+-- Permanently deletes a search domain and all of its data. Once a domain has been deleted, it cannot be recovered. For more information, see <http://docs.aws.amazon.com/cloudsearch/latest/developerguide/deleting-domains.html Deleting a Search Domain> in the /Amazon CloudSearch Developer Guide/ .+--+-- module Network.AWS.CloudSearch.DeleteDomain ( -- * Creating a Request@@ -42,8 +44,10 @@ import Network.AWS.Request import Network.AWS.Response --- | Container for the parameters to the 'DeleteDomain' operation. Specifies the name of the domain you want to delete.+-- | Container for the parameters to the @'DeleteDomain' @ operation. Specifies the name of the domain you want to delete. --+--+-- -- /See:/ 'deleteDomain' smart constructor. newtype DeleteDomain = DeleteDomain' { _dddDomainName :: Text@@ -53,7 +57,7 @@ -- -- Use one of the following lenses to modify other fields as desired: ----- * 'dddDomainName'+-- * 'dddDomainName' - The name of the domain you want to permanently delete. deleteDomain :: Text -- ^ 'dddDomainName' -> DeleteDomain@@ -92,8 +96,10 @@ "Version" =: ("2013-01-01" :: ByteString), "DomainName" =: _dddDomainName] --- | 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.+-- | 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 = DeleteDomainResponse' { _ddrsDomainStatus :: !(Maybe DomainStatus)@@ -104,9 +110,9 @@ -- -- Use one of the following lenses to modify other fields as desired: ----- * 'ddrsDomainStatus'+-- * 'ddrsDomainStatus' - Undocumented member. ----- * 'ddrsResponseStatus'+-- * 'ddrsResponseStatus' - -- | The response status code. deleteDomainResponse :: Int -- ^ 'ddrsResponseStatus' -> DeleteDomainResponse@@ -120,7 +126,7 @@ ddrsDomainStatus :: Lens' DeleteDomainResponse (Maybe DomainStatus) ddrsDomainStatus = lens _ddrsDomainStatus (\ s a -> s{_ddrsDomainStatus = a}); --- | The response status code.+-- | -- | The response status code. ddrsResponseStatus :: Lens' DeleteDomainResponse Int ddrsResponseStatus = lens _ddrsResponseStatus (\ s a -> s{_ddrsResponseStatus = a});
gen/Network/AWS/CloudSearch/DeleteExpression.hs view
@@ -18,7 +18,9 @@ -- Stability : auto-generated -- Portability : non-portable (GHC extensions) ----- Removes an 'Expression' from the search domain. For more information, see <http://docs.aws.amazon.com/cloudsearch/latest/developerguide/configuring-expressions.html Configuring Expressions> in the /Amazon CloudSearch Developer Guide/.+-- Removes an @'Expression' @ from the search domain. For more information, see <http://docs.aws.amazon.com/cloudsearch/latest/developerguide/configuring-expressions.html Configuring Expressions> in the /Amazon CloudSearch Developer Guide/ .+--+-- module Network.AWS.CloudSearch.DeleteExpression ( -- * Creating a Request@@ -43,8 +45,10 @@ import Network.AWS.Request import Network.AWS.Response --- | 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.+-- | 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 = DeleteExpression' { _delDomainName :: !Text@@ -55,9 +59,9 @@ -- -- Use one of the following lenses to modify other fields as desired: ----- * 'delDomainName'+-- * 'delDomainName' - Undocumented member. ----- * 'delExpressionName'+-- * 'delExpressionName' - The name of the @'Expression' @ to delete. deleteExpression :: Text -- ^ 'delDomainName' -> Text -- ^ 'delExpressionName'@@ -72,7 +76,7 @@ delDomainName :: Lens' DeleteExpression Text delDomainName = lens _delDomainName (\ s a -> s{_delDomainName = a}); --- | The name of the 'Expression' to delete.+-- | The name of the @'Expression' @ to delete. delExpressionName :: Lens' DeleteExpression Text delExpressionName = lens _delExpressionName (\ s a -> s{_delExpressionName = a}); @@ -103,8 +107,10 @@ "DomainName" =: _delDomainName, "ExpressionName" =: _delExpressionName] --- | The result of a 'DeleteExpression' request. Specifies the expression being deleted.+-- | The result of a @'DeleteExpression' @ request. Specifies the expression being deleted. --+--+-- -- /See:/ 'deleteExpressionResponse' smart constructor. data DeleteExpressionResponse = DeleteExpressionResponse' { _delrsResponseStatus :: !Int@@ -115,9 +121,9 @@ -- -- Use one of the following lenses to modify other fields as desired: ----- * 'delrsResponseStatus'+-- * 'delrsResponseStatus' - -- | The response status code. ----- * 'delrsExpression'+-- * 'delrsExpression' - The status of the expression being deleted. deleteExpressionResponse :: Int -- ^ 'delrsResponseStatus' -> ExpressionStatus -- ^ 'delrsExpression'@@ -128,7 +134,7 @@ , _delrsExpression = pExpression_ } --- | The response status code.+-- | -- | The response status code. delrsResponseStatus :: Lens' DeleteExpressionResponse Int delrsResponseStatus = lens _delrsResponseStatus (\ s a -> s{_delrsResponseStatus = a});
gen/Network/AWS/CloudSearch/DeleteIndexField.hs view
@@ -18,7 +18,9 @@ -- Stability : auto-generated -- Portability : non-portable (GHC extensions) ----- Removes an 'IndexField' from the search domain. For more information, see <http://docs.aws.amazon.com/cloudsearch/latest/developerguide/configuring-index-fields.html Configuring Index Fields> in the /Amazon CloudSearch Developer Guide/.+-- Removes an @'IndexField' @ from the search domain. For more information, see <http://docs.aws.amazon.com/cloudsearch/latest/developerguide/configuring-index-fields.html Configuring Index Fields> in the /Amazon CloudSearch Developer Guide/ .+--+-- module Network.AWS.CloudSearch.DeleteIndexField ( -- * Creating a Request@@ -43,8 +45,10 @@ import Network.AWS.Request import Network.AWS.Response --- | 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.+-- | 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 = DeleteIndexField' { _difiDomainName :: !Text@@ -55,9 +59,9 @@ -- -- Use one of the following lenses to modify other fields as desired: ----- * 'difiDomainName'+-- * 'difiDomainName' - Undocumented member. ----- * 'difiIndexFieldName'+-- * 'difiIndexFieldName' - The name of the index field your want to remove from the domain's indexing options. deleteIndexField :: Text -- ^ 'difiDomainName' -> Text -- ^ 'difiIndexFieldName'@@ -72,7 +76,7 @@ difiDomainName :: Lens' DeleteIndexField Text difiDomainName = lens _difiDomainName (\ s a -> s{_difiDomainName = a}); --- | The name of the index field your want to remove from the domain\'s indexing options.+-- | The name of the index field your want to remove from the domain's indexing options. difiIndexFieldName :: Lens' DeleteIndexField Text difiIndexFieldName = lens _difiIndexFieldName (\ s a -> s{_difiIndexFieldName = a}); @@ -103,8 +107,10 @@ "DomainName" =: _difiDomainName, "IndexFieldName" =: _difiIndexFieldName] --- | The result of a 'DeleteIndexField' request.+-- | The result of a @'DeleteIndexField' @ request. --+--+-- -- /See:/ 'deleteIndexFieldResponse' smart constructor. data DeleteIndexFieldResponse = DeleteIndexFieldResponse' { _difrsResponseStatus :: !Int@@ -115,9 +121,9 @@ -- -- Use one of the following lenses to modify other fields as desired: ----- * 'difrsResponseStatus'+-- * 'difrsResponseStatus' - -- | The response status code. ----- * 'difrsIndexField'+-- * 'difrsIndexField' - The status of the index field being deleted. deleteIndexFieldResponse :: Int -- ^ 'difrsResponseStatus' -> IndexFieldStatus -- ^ 'difrsIndexField'@@ -128,7 +134,7 @@ , _difrsIndexField = pIndexField_ } --- | The response status code.+-- | -- | The response status code. difrsResponseStatus :: Lens' DeleteIndexFieldResponse Int difrsResponseStatus = lens _difrsResponseStatus (\ s a -> s{_difrsResponseStatus = a});
gen/Network/AWS/CloudSearch/DeleteSuggester.hs view
@@ -18,7 +18,9 @@ -- Stability : auto-generated -- Portability : non-portable (GHC extensions) ----- Deletes a suggester. For more information, see <http://docs.aws.amazon.com/cloudsearch/latest/developerguide/getting-suggestions.html Getting Search Suggestions> in the /Amazon CloudSearch Developer Guide/.+-- Deletes a suggester. For more information, see <http://docs.aws.amazon.com/cloudsearch/latest/developerguide/getting-suggestions.html Getting Search Suggestions> in the /Amazon CloudSearch Developer Guide/ .+--+-- module Network.AWS.CloudSearch.DeleteSuggester ( -- * Creating a Request@@ -43,8 +45,10 @@ import Network.AWS.Request import Network.AWS.Response --- | 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.+-- | 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 = DeleteSuggester' { _ddDomainName :: !Text@@ -55,9 +59,9 @@ -- -- Use one of the following lenses to modify other fields as desired: ----- * 'ddDomainName'+-- * 'ddDomainName' - Undocumented member. ----- * 'ddSuggesterName'+-- * 'ddSuggesterName' - Specifies the name of the suggester you want to delete. deleteSuggester :: Text -- ^ 'ddDomainName' -> Text -- ^ 'ddSuggesterName'@@ -103,8 +107,10 @@ "DomainName" =: _ddDomainName, "SuggesterName" =: _ddSuggesterName] --- | The result of a 'DeleteSuggester' request. Contains the status of the deleted suggester.+-- | The result of a @DeleteSuggester@ request. Contains the status of the deleted suggester. --+--+-- -- /See:/ 'deleteSuggesterResponse' smart constructor. data DeleteSuggesterResponse = DeleteSuggesterResponse' { _delersResponseStatus :: !Int@@ -115,9 +121,9 @@ -- -- Use one of the following lenses to modify other fields as desired: ----- * 'delersResponseStatus'+-- * 'delersResponseStatus' - -- | The response status code. ----- * 'delersSuggester'+-- * 'delersSuggester' - The status of the suggester being deleted. deleteSuggesterResponse :: Int -- ^ 'delersResponseStatus' -> SuggesterStatus -- ^ 'delersSuggester'@@ -128,7 +134,7 @@ , _delersSuggester = pSuggester_ } --- | The response status code.+-- | -- | The response status code. delersResponseStatus :: Lens' DeleteSuggesterResponse Int delersResponseStatus = lens _delersResponseStatus (\ s a -> s{_delersResponseStatus = a});
gen/Network/AWS/CloudSearch/DescribeAnalysisSchemes.hs view
@@ -18,7 +18,9 @@ -- Stability : auto-generated -- Portability : non-portable (GHC extensions) ----- 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 <http://docs.aws.amazon.com/cloudsearch/latest/developerguide/configuring-analysis-schemes.html Configuring Analysis Schemes> in the /Amazon CloudSearch Developer Guide/.+-- 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 <http://docs.aws.amazon.com/cloudsearch/latest/developerguide/configuring-analysis-schemes.html Configuring Analysis Schemes> in the /Amazon CloudSearch Developer Guide/ .+--+-- module Network.AWS.CloudSearch.DescribeAnalysisSchemes ( -- * Creating a Request@@ -44,8 +46,10 @@ import Network.AWS.Request import Network.AWS.Response --- | 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'.+-- | 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 = DescribeAnalysisSchemes' { _dassDeployed :: !(Maybe Bool)@@ -57,11 +61,11 @@ -- -- Use one of the following lenses to modify other fields as desired: ----- * 'dassDeployed'+-- * 'dassDeployed' - Whether to display the deployed configuration (@true@ ) or include any pending changes (@false@ ). Defaults to @false@ . ----- * 'dassAnalysisSchemeNames'+-- * 'dassAnalysisSchemeNames' - The analysis schemes you want to describe. ----- * 'dassDomainName'+-- * 'dassDomainName' - The name of the domain you want to describe. describeAnalysisSchemes :: Text -- ^ 'dassDomainName' -> DescribeAnalysisSchemes@@ -72,7 +76,7 @@ , _dassDomainName = pDomainName_ } --- | Whether to display the deployed configuration ('true') or include any pending changes ('false'). Defaults to 'false'.+-- | Whether to display the deployed configuration (@true@ ) or include any pending changes (@false@ ). Defaults to @false@ . dassDeployed :: Lens' DescribeAnalysisSchemes (Maybe Bool) dassDeployed = lens _dassDeployed (\ s a -> s{_dassDeployed = a}); @@ -118,8 +122,10 @@ (toQueryList "member" <$> _dassAnalysisSchemeNames), "DomainName" =: _dassDomainName] --- | The result of a 'DescribeAnalysisSchemes' request. Contains the analysis schemes configured for the domain specified in the request.+-- | The result of a @DescribeAnalysisSchemes@ request. Contains the analysis schemes configured for the domain specified in the request. --+--+-- -- /See:/ 'describeAnalysisSchemesResponse' smart constructor. data DescribeAnalysisSchemesResponse = DescribeAnalysisSchemesResponse' { _dasrsResponseStatus :: !Int@@ -130,9 +136,9 @@ -- -- Use one of the following lenses to modify other fields as desired: ----- * 'dasrsResponseStatus'+-- * 'dasrsResponseStatus' - -- | The response status code. ----- * 'dasrsAnalysisSchemes'+-- * 'dasrsAnalysisSchemes' - The analysis scheme descriptions. describeAnalysisSchemesResponse :: Int -- ^ 'dasrsResponseStatus' -> DescribeAnalysisSchemesResponse@@ -142,7 +148,7 @@ , _dasrsAnalysisSchemes = mempty } --- | The response status code.+-- | -- | The response status code. dasrsResponseStatus :: Lens' DescribeAnalysisSchemesResponse Int dasrsResponseStatus = lens _dasrsResponseStatus (\ s a -> s{_dasrsResponseStatus = a});
gen/Network/AWS/CloudSearch/DescribeAvailabilityOptions.hs view
@@ -18,7 +18,9 @@ -- Stability : auto-generated -- Portability : non-portable (GHC extensions) ----- 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 <http://docs.aws.amazon.com/cloudsearch/latest/developerguide/configuring-availability-options.html Configuring Availability Options> in the /Amazon CloudSearch Developer Guide/.+-- 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 <http://docs.aws.amazon.com/cloudsearch/latest/developerguide/configuring-availability-options.html Configuring Availability Options> in the /Amazon CloudSearch Developer Guide/ .+--+-- module Network.AWS.CloudSearch.DescribeAvailabilityOptions ( -- * Creating a Request@@ -43,8 +45,10 @@ import Network.AWS.Request import Network.AWS.Response --- | 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'.+-- | 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 = DescribeAvailabilityOptions' { _daoDeployed :: !(Maybe Bool)@@ -55,9 +59,9 @@ -- -- Use one of the following lenses to modify other fields as desired: ----- * 'daoDeployed'+-- * 'daoDeployed' - Whether to display the deployed configuration (@true@ ) or include any pending changes (@false@ ). Defaults to @false@ . ----- * 'daoDomainName'+-- * 'daoDomainName' - The name of the domain you want to describe. describeAvailabilityOptions :: Text -- ^ 'daoDomainName' -> DescribeAvailabilityOptions@@ -67,7 +71,7 @@ , _daoDomainName = pDomainName_ } --- | Whether to display the deployed configuration ('true') or include any pending changes ('false'). Defaults to 'false'.+-- | Whether to display the deployed configuration (@true@ ) or include any pending changes (@false@ ). Defaults to @false@ . daoDeployed :: Lens' DescribeAvailabilityOptions (Maybe Bool) daoDeployed = lens _daoDeployed (\ s a -> s{_daoDeployed = a}); @@ -106,8 +110,10 @@ "Deployed" =: _daoDeployed, "DomainName" =: _daoDomainName] --- | The result of a 'DescribeAvailabilityOptions' request. Indicates whether or not the Multi-AZ option is enabled for the domain specified in the request.+-- | 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 = DescribeAvailabilityOptionsResponse' { _daorsAvailabilityOptions :: !(Maybe AvailabilityOptionsStatus)@@ -118,9 +124,9 @@ -- -- Use one of the following lenses to modify other fields as desired: ----- * 'daorsAvailabilityOptions'+-- * 'daorsAvailabilityOptions' - The availability options configured for the domain. Indicates whether Multi-AZ is enabled for the domain. ----- * 'daorsResponseStatus'+-- * 'daorsResponseStatus' - -- | The response status code. describeAvailabilityOptionsResponse :: Int -- ^ 'daorsResponseStatus' -> DescribeAvailabilityOptionsResponse@@ -134,7 +140,7 @@ daorsAvailabilityOptions :: Lens' DescribeAvailabilityOptionsResponse (Maybe AvailabilityOptionsStatus) daorsAvailabilityOptions = lens _daorsAvailabilityOptions (\ s a -> s{_daorsAvailabilityOptions = a}); --- | The response status code.+-- | -- | The response status code. daorsResponseStatus :: Lens' DescribeAvailabilityOptionsResponse Int daorsResponseStatus = lens _daorsResponseStatus (\ s a -> s{_daorsResponseStatus = a});
gen/Network/AWS/CloudSearch/DescribeDomains.hs view
@@ -18,7 +18,9 @@ -- Stability : auto-generated -- Portability : non-portable (GHC extensions) ----- 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 <http://docs.aws.amazon.com/cloudsearch/latest/developerguide/getting-domain-info.html Getting Information about a Search Domain> in the /Amazon CloudSearch Developer Guide/.+-- 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 <http://docs.aws.amazon.com/cloudsearch/latest/developerguide/getting-domain-info.html Getting Information about a Search Domain> in the /Amazon CloudSearch Developer Guide/ .+--+-- module Network.AWS.CloudSearch.DescribeDomains ( -- * Creating a Request@@ -42,8 +44,10 @@ import Network.AWS.Request import Network.AWS.Response --- | 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.+-- | 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. newtype DescribeDomains = DescribeDomains' { _ddDomainNames :: Maybe [Text]@@ -53,7 +57,7 @@ -- -- Use one of the following lenses to modify other fields as desired: ----- * 'ddDomainNames'+-- * 'ddDomainNames' - The names of the domains you want to include in the response. describeDomains :: DescribeDomains describeDomains =@@ -94,8 +98,10 @@ "DomainNames" =: toQuery (toQueryList "member" <$> _ddDomainNames)] --- | The result of a 'DescribeDomains' request. Contains the status of the domains specified in the request or all domains owned by the account.+-- | 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 = DescribeDomainsResponse' { _ddsrsResponseStatus :: !Int@@ -106,9 +112,9 @@ -- -- Use one of the following lenses to modify other fields as desired: ----- * 'ddsrsResponseStatus'+-- * 'ddsrsResponseStatus' - -- | The response status code. ----- * 'ddsrsDomainStatusList'+-- * 'ddsrsDomainStatusList' - Undocumented member. describeDomainsResponse :: Int -- ^ 'ddsrsResponseStatus' -> DescribeDomainsResponse@@ -118,7 +124,7 @@ , _ddsrsDomainStatusList = mempty } --- | The response status code.+-- | -- | The response status code. ddsrsResponseStatus :: Lens' DescribeDomainsResponse Int ddsrsResponseStatus = lens _ddsrsResponseStatus (\ s a -> s{_ddsrsResponseStatus = a});
gen/Network/AWS/CloudSearch/DescribeExpressions.hs view
@@ -18,7 +18,9 @@ -- Stability : auto-generated -- Portability : non-portable (GHC extensions) ----- 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 <http://docs.aws.amazon.com/cloudsearch/latest/developerguide/configuring-expressions.html Configuring Expressions> in the /Amazon CloudSearch Developer Guide/.+-- 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 <http://docs.aws.amazon.com/cloudsearch/latest/developerguide/configuring-expressions.html Configuring Expressions> in the /Amazon CloudSearch Developer Guide/ .+--+-- module Network.AWS.CloudSearch.DescribeExpressions ( -- * Creating a Request@@ -44,8 +46,10 @@ import Network.AWS.Request import Network.AWS.Response --- | 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'.+-- | 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 = DescribeExpressions' { _deDeployed :: !(Maybe Bool)@@ -57,11 +61,11 @@ -- -- Use one of the following lenses to modify other fields as desired: ----- * 'deDeployed'+-- * 'deDeployed' - Whether to display the deployed configuration (@true@ ) or include any pending changes (@false@ ). Defaults to @false@ . ----- * 'deExpressionNames'+-- * 'deExpressionNames' - Limits the @'DescribeExpressions' @ response to the specified expressions. If not specified, all expressions are shown. ----- * 'deDomainName'+-- * 'deDomainName' - The name of the domain you want to describe. describeExpressions :: Text -- ^ 'deDomainName' -> DescribeExpressions@@ -72,11 +76,11 @@ , _deDomainName = pDomainName_ } --- | Whether to display the deployed configuration ('true') or include any pending changes ('false'). Defaults to 'false'.+-- | Whether to display the deployed configuration (@true@ ) or include any pending changes (@false@ ). Defaults to @false@ . deDeployed :: Lens' DescribeExpressions (Maybe Bool) deDeployed = lens _deDeployed (\ s a -> s{_deDeployed = a}); --- | Limits the 'DescribeExpressions' response to the specified expressions. If not specified, all expressions are shown.+-- | Limits the @'DescribeExpressions' @ response to the specified expressions. If not specified, all expressions are shown. deExpressionNames :: Lens' DescribeExpressions [Text] deExpressionNames = lens _deExpressionNames (\ s a -> s{_deExpressionNames = a}) . _Default . _Coerce; @@ -117,8 +121,10 @@ (toQueryList "member" <$> _deExpressionNames), "DomainName" =: _deDomainName] --- | The result of a 'DescribeExpressions' request. Contains the expressions configured for the domain specified in the request.+-- | The result of a @DescribeExpressions@ request. Contains the expressions configured for the domain specified in the request. --+--+-- -- /See:/ 'describeExpressionsResponse' smart constructor. data DescribeExpressionsResponse = DescribeExpressionsResponse' { _drsResponseStatus :: !Int@@ -129,9 +135,9 @@ -- -- Use one of the following lenses to modify other fields as desired: ----- * 'drsResponseStatus'+-- * 'drsResponseStatus' - -- | The response status code. ----- * 'drsExpressions'+-- * 'drsExpressions' - The expressions configured for the domain. describeExpressionsResponse :: Int -- ^ 'drsResponseStatus' -> DescribeExpressionsResponse@@ -141,7 +147,7 @@ , _drsExpressions = mempty } --- | The response status code.+-- | -- | The response status code. drsResponseStatus :: Lens' DescribeExpressionsResponse Int drsResponseStatus = lens _drsResponseStatus (\ s a -> s{_drsResponseStatus = a});
gen/Network/AWS/CloudSearch/DescribeIndexFields.hs view
@@ -18,7 +18,9 @@ -- Stability : auto-generated -- Portability : non-portable (GHC extensions) ----- 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 <http://docs.aws.amazon.com/cloudsearch/latest/developerguide/getting-domain-info.html Getting Domain Information> in the /Amazon CloudSearch Developer Guide/.+-- 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 <http://docs.aws.amazon.com/cloudsearch/latest/developerguide/getting-domain-info.html Getting Domain Information> in the /Amazon CloudSearch Developer Guide/ .+--+-- module Network.AWS.CloudSearch.DescribeIndexFields ( -- * Creating a Request@@ -44,8 +46,10 @@ import Network.AWS.Request import Network.AWS.Response --- | 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'.+-- | 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 = DescribeIndexFields' { _difDeployed :: !(Maybe Bool)@@ -57,11 +61,11 @@ -- -- Use one of the following lenses to modify other fields as desired: ----- * 'difDeployed'+-- * 'difDeployed' - Whether to display the deployed configuration (@true@ ) or include any pending changes (@false@ ). Defaults to @false@ . ----- * 'difFieldNames'+-- * 'difFieldNames' - A list of the index fields you want to describe. If not specified, information is returned for all configured index fields. ----- * 'difDomainName'+-- * 'difDomainName' - The name of the domain you want to describe. describeIndexFields :: Text -- ^ 'difDomainName' -> DescribeIndexFields@@ -72,7 +76,7 @@ , _difDomainName = pDomainName_ } --- | Whether to display the deployed configuration ('true') or include any pending changes ('false'). Defaults to 'false'.+-- | Whether to display the deployed configuration (@true@ ) or include any pending changes (@false@ ). Defaults to @false@ . difDeployed :: Lens' DescribeIndexFields (Maybe Bool) difDeployed = lens _difDeployed (\ s a -> s{_difDeployed = a}); @@ -116,8 +120,10 @@ toQuery (toQueryList "member" <$> _difFieldNames), "DomainName" =: _difDomainName] --- | The result of a 'DescribeIndexFields' request. Contains the index fields configured for the domain specified in the request.+-- | The result of a @DescribeIndexFields@ request. Contains the index fields configured for the domain specified in the request. --+--+-- -- /See:/ 'describeIndexFieldsResponse' smart constructor. data DescribeIndexFieldsResponse = DescribeIndexFieldsResponse' { _difsrsResponseStatus :: !Int@@ -128,9 +134,9 @@ -- -- Use one of the following lenses to modify other fields as desired: ----- * 'difsrsResponseStatus'+-- * 'difsrsResponseStatus' - -- | The response status code. ----- * 'difsrsIndexFields'+-- * 'difsrsIndexFields' - The index fields configured for the domain. describeIndexFieldsResponse :: Int -- ^ 'difsrsResponseStatus' -> DescribeIndexFieldsResponse@@ -140,7 +146,7 @@ , _difsrsIndexFields = mempty } --- | The response status code.+-- | -- | The response status code. difsrsResponseStatus :: Lens' DescribeIndexFieldsResponse Int difsrsResponseStatus = lens _difsrsResponseStatus (\ s a -> s{_difsrsResponseStatus = a});
gen/Network/AWS/CloudSearch/DescribeScalingParameters.hs view
@@ -18,7 +18,9 @@ -- Stability : auto-generated -- Portability : non-portable (GHC extensions) ----- 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 <http://docs.aws.amazon.com/cloudsearch/latest/developerguide/configuring-scaling-options.html Configuring Scaling Options> in the /Amazon CloudSearch Developer Guide/.+-- 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 <http://docs.aws.amazon.com/cloudsearch/latest/developerguide/configuring-scaling-options.html Configuring Scaling Options> in the /Amazon CloudSearch Developer Guide/ .+--+-- module Network.AWS.CloudSearch.DescribeScalingParameters ( -- * Creating a Request@@ -42,8 +44,10 @@ import Network.AWS.Request import Network.AWS.Response --- | Container for the parameters to the 'DescribeScalingParameters' operation. Specifies the name of the domain you want to describe.+-- | Container for the parameters to the @'DescribeScalingParameters' @ operation. Specifies the name of the domain you want to describe. --+--+-- -- /See:/ 'describeScalingParameters' smart constructor. newtype DescribeScalingParameters = DescribeScalingParameters' { _dspDomainName :: Text@@ -53,7 +57,7 @@ -- -- Use one of the following lenses to modify other fields as desired: ----- * 'dspDomainName'+-- * 'dspDomainName' - Undocumented member. describeScalingParameters :: Text -- ^ 'dspDomainName' -> DescribeScalingParameters@@ -94,8 +98,10 @@ "Version" =: ("2013-01-01" :: ByteString), "DomainName" =: _dspDomainName] --- | The result of a 'DescribeScalingParameters' request. Contains the scaling parameters configured for the domain specified in the request.+-- | The result of a @DescribeScalingParameters@ request. Contains the scaling parameters configured for the domain specified in the request. --+--+-- -- /See:/ 'describeScalingParametersResponse' smart constructor. data DescribeScalingParametersResponse = DescribeScalingParametersResponse' { _dsprsResponseStatus :: !Int@@ -106,9 +112,9 @@ -- -- Use one of the following lenses to modify other fields as desired: ----- * 'dsprsResponseStatus'+-- * 'dsprsResponseStatus' - -- | The response status code. ----- * 'dsprsScalingParameters'+-- * 'dsprsScalingParameters' - Undocumented member. describeScalingParametersResponse :: Int -- ^ 'dsprsResponseStatus' -> ScalingParametersStatus -- ^ 'dsprsScalingParameters'@@ -119,7 +125,7 @@ , _dsprsScalingParameters = pScalingParameters_ } --- | The response status code.+-- | -- | The response status code. dsprsResponseStatus :: Lens' DescribeScalingParametersResponse Int dsprsResponseStatus = lens _dsprsResponseStatus (\ s a -> s{_dsprsResponseStatus = a});
gen/Network/AWS/CloudSearch/DescribeServiceAccessPolicies.hs view
@@ -18,7 +18,9 @@ -- Stability : auto-generated -- Portability : non-portable (GHC extensions) ----- 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 <http://docs.aws.amazon.com/cloudsearch/latest/developerguide/configuring-access.html Configuring Access for a Search Domain> in the /Amazon CloudSearch Developer Guide/.+-- 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 <http://docs.aws.amazon.com/cloudsearch/latest/developerguide/configuring-access.html Configuring Access for a Search Domain> in the /Amazon CloudSearch Developer Guide/ .+--+-- module Network.AWS.CloudSearch.DescribeServiceAccessPolicies ( -- * Creating a Request@@ -43,8 +45,10 @@ import Network.AWS.Request import Network.AWS.Response --- | 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'.+-- | 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 = DescribeServiceAccessPolicies' { _dsapDeployed :: !(Maybe Bool)@@ -55,9 +59,9 @@ -- -- Use one of the following lenses to modify other fields as desired: ----- * 'dsapDeployed'+-- * 'dsapDeployed' - Whether to display the deployed configuration (@true@ ) or include any pending changes (@false@ ). Defaults to @false@ . ----- * 'dsapDomainName'+-- * 'dsapDomainName' - The name of the domain you want to describe. describeServiceAccessPolicies :: Text -- ^ 'dsapDomainName' -> DescribeServiceAccessPolicies@@ -67,7 +71,7 @@ , _dsapDomainName = pDomainName_ } --- | Whether to display the deployed configuration ('true') or include any pending changes ('false'). Defaults to 'false'.+-- | Whether to display the deployed configuration (@true@ ) or include any pending changes (@false@ ). Defaults to @false@ . dsapDeployed :: Lens' DescribeServiceAccessPolicies (Maybe Bool) dsapDeployed = lens _dsapDeployed (\ s a -> s{_dsapDeployed = a}); @@ -107,8 +111,10 @@ "Deployed" =: _dsapDeployed, "DomainName" =: _dsapDomainName] --- | The result of a 'DescribeServiceAccessPolicies' request.+-- | The result of a @DescribeServiceAccessPolicies@ request. --+--+-- -- /See:/ 'describeServiceAccessPoliciesResponse' smart constructor. data DescribeServiceAccessPoliciesResponse = DescribeServiceAccessPoliciesResponse' { _dsaprsResponseStatus :: !Int@@ -119,9 +125,9 @@ -- -- Use one of the following lenses to modify other fields as desired: ----- * 'dsaprsResponseStatus'+-- * 'dsaprsResponseStatus' - -- | The response status code. ----- * 'dsaprsAccessPolicies'+-- * 'dsaprsAccessPolicies' - The access rules configured for the domain specified in the request. describeServiceAccessPoliciesResponse :: Int -- ^ 'dsaprsResponseStatus' -> AccessPoliciesStatus -- ^ 'dsaprsAccessPolicies'@@ -132,7 +138,7 @@ , _dsaprsAccessPolicies = pAccessPolicies_ } --- | The response status code.+-- | -- | The response status code. dsaprsResponseStatus :: Lens' DescribeServiceAccessPoliciesResponse Int dsaprsResponseStatus = lens _dsaprsResponseStatus (\ s a -> s{_dsaprsResponseStatus = a});
gen/Network/AWS/CloudSearch/DescribeSuggesters.hs view
@@ -18,7 +18,9 @@ -- Stability : auto-generated -- Portability : non-portable (GHC extensions) ----- 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 <http://docs.aws.amazon.com/cloudsearch/latest/developerguide/getting-suggestions.html Getting Search Suggestions> in the /Amazon CloudSearch Developer Guide/.+-- 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 <http://docs.aws.amazon.com/cloudsearch/latest/developerguide/getting-suggestions.html Getting Search Suggestions> in the /Amazon CloudSearch Developer Guide/ .+--+-- module Network.AWS.CloudSearch.DescribeSuggesters ( -- * Creating a Request@@ -44,8 +46,10 @@ import Network.AWS.Request import Network.AWS.Response --- | 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'.+-- | 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 = DescribeSuggesters' { _dssDeployed :: !(Maybe Bool)@@ -57,11 +61,11 @@ -- -- Use one of the following lenses to modify other fields as desired: ----- * 'dssDeployed'+-- * 'dssDeployed' - Whether to display the deployed configuration (@true@ ) or include any pending changes (@false@ ). Defaults to @false@ . ----- * 'dssSuggesterNames'+-- * 'dssSuggesterNames' - The suggesters you want to describe. ----- * 'dssDomainName'+-- * 'dssDomainName' - The name of the domain you want to describe. describeSuggesters :: Text -- ^ 'dssDomainName' -> DescribeSuggesters@@ -72,7 +76,7 @@ , _dssDomainName = pDomainName_ } --- | Whether to display the deployed configuration ('true') or include any pending changes ('false'). Defaults to 'false'.+-- | Whether to display the deployed configuration (@true@ ) or include any pending changes (@false@ ). Defaults to @false@ . dssDeployed :: Lens' DescribeSuggesters (Maybe Bool) dssDeployed = lens _dssDeployed (\ s a -> s{_dssDeployed = a}); @@ -117,8 +121,10 @@ (toQueryList "member" <$> _dssSuggesterNames), "DomainName" =: _dssDomainName] --- | The result of a 'DescribeSuggesters' request.+-- | The result of a @DescribeSuggesters@ request. --+--+-- -- /See:/ 'describeSuggestersResponse' smart constructor. data DescribeSuggestersResponse = DescribeSuggestersResponse' { _dssrsResponseStatus :: !Int@@ -129,9 +135,9 @@ -- -- Use one of the following lenses to modify other fields as desired: ----- * 'dssrsResponseStatus'+-- * 'dssrsResponseStatus' - -- | The response status code. ----- * 'dssrsSuggesters'+-- * 'dssrsSuggesters' - The suggesters configured for the domain specified in the request. describeSuggestersResponse :: Int -- ^ 'dssrsResponseStatus' -> DescribeSuggestersResponse@@ -141,7 +147,7 @@ , _dssrsSuggesters = mempty } --- | The response status code.+-- | -- | The response status code. dssrsResponseStatus :: Lens' DescribeSuggestersResponse Int dssrsResponseStatus = lens _dssrsResponseStatus (\ s a -> s{_dssrsResponseStatus = a});
gen/Network/AWS/CloudSearch/IndexDocuments.hs view
@@ -18,7 +18,9 @@ -- Stability : auto-generated -- Portability : non-portable (GHC extensions) ----- 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'.+-- 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@ .+--+-- module Network.AWS.CloudSearch.IndexDocuments ( -- * Creating a Request@@ -42,8 +44,10 @@ import Network.AWS.Request import Network.AWS.Response --- | Container for the parameters to the 'IndexDocuments' operation. Specifies the name of the domain you want to re-index.+-- | Container for the parameters to the @'IndexDocuments' @ operation. Specifies the name of the domain you want to re-index. --+--+-- -- /See:/ 'indexDocuments' smart constructor. newtype IndexDocuments = IndexDocuments' { _idDomainName :: Text@@ -53,7 +57,7 @@ -- -- Use one of the following lenses to modify other fields as desired: ----- * 'idDomainName'+-- * 'idDomainName' - Undocumented member. indexDocuments :: Text -- ^ 'idDomainName' -> IndexDocuments@@ -94,8 +98,10 @@ "Version" =: ("2013-01-01" :: ByteString), "DomainName" =: _idDomainName] --- | The result of an 'IndexDocuments' request. Contains the status of the indexing operation, including the fields being indexed.+-- | The result of an @IndexDocuments@ request. Contains the status of the indexing operation, including the fields being indexed. --+--+-- -- /See:/ 'indexDocumentsResponse' smart constructor. data IndexDocumentsResponse = IndexDocumentsResponse' { _idrsFieldNames :: !(Maybe [Text])@@ -106,9 +112,9 @@ -- -- Use one of the following lenses to modify other fields as desired: ----- * 'idrsFieldNames'+-- * 'idrsFieldNames' - The names of the fields that are currently being indexed. ----- * 'idrsResponseStatus'+-- * 'idrsResponseStatus' - -- | The response status code. indexDocumentsResponse :: Int -- ^ 'idrsResponseStatus' -> IndexDocumentsResponse@@ -122,7 +128,7 @@ idrsFieldNames :: Lens' IndexDocumentsResponse [Text] idrsFieldNames = lens _idrsFieldNames (\ s a -> s{_idrsFieldNames = a}) . _Default . _Coerce; --- | The response status code.+-- | -- | The response status code. idrsResponseStatus :: Lens' IndexDocumentsResponse Int idrsResponseStatus = lens _idrsResponseStatus (\ s a -> s{_idrsResponseStatus = a});
gen/Network/AWS/CloudSearch/ListDomainNames.hs view
@@ -19,6 +19,8 @@ -- Portability : non-portable (GHC extensions) -- -- Lists all search domains owned by an account.+--+-- module Network.AWS.CloudSearch.ListDomainNames ( -- * Creating a Request@@ -79,8 +81,10 @@ ["Action" =: ("ListDomainNames" :: ByteString), "Version" =: ("2013-01-01" :: ByteString)]) --- | The result of a 'ListDomainNames' request. Contains a list of the domains owned by an account.+-- | The result of a @ListDomainNames@ request. Contains a list of the domains owned by an account. --+--+-- -- /See:/ 'listDomainNamesResponse' smart constructor. data ListDomainNamesResponse = ListDomainNamesResponse' { _ldnrsDomainNames :: !(Maybe (Map Text Text))@@ -91,9 +95,9 @@ -- -- Use one of the following lenses to modify other fields as desired: ----- * 'ldnrsDomainNames'+-- * 'ldnrsDomainNames' - The names of the search domains owned by an account. ----- * 'ldnrsResponseStatus'+-- * 'ldnrsResponseStatus' - -- | The response status code. listDomainNamesResponse :: Int -- ^ 'ldnrsResponseStatus' -> ListDomainNamesResponse@@ -107,7 +111,7 @@ ldnrsDomainNames :: Lens' ListDomainNamesResponse (HashMap Text Text) ldnrsDomainNames = lens _ldnrsDomainNames (\ s a -> s{_ldnrsDomainNames = a}) . _Default . _Map; --- | The response status code.+-- | -- | The response status code. ldnrsResponseStatus :: Lens' ListDomainNamesResponse Int ldnrsResponseStatus = lens _ldnrsResponseStatus (\ s a -> s{_ldnrsResponseStatus = a});
gen/Network/AWS/CloudSearch/Types.hs view
@@ -291,7 +291,7 @@ import Network.AWS.Prelude import Network.AWS.Sign.V4 --- | API version '2013-01-01' of the Amazon CloudSearch SDK configuration.+-- | API version @2013-01-01@ of the Amazon CloudSearch SDK configuration. cloudSearch :: Service cloudSearch = Service@@ -328,29 +328,41 @@ | otherwise = Nothing -- | An error occurred while processing the request.+--+-- _BaseException :: AsError a => Getting (First ServiceError) a ServiceError _BaseException = _ServiceError . hasCode "BaseException" -- | The request was rejected because it attempted an operation which is not enabled.+--+-- _DisabledOperationException :: AsError a => Getting (First ServiceError) a ServiceError _DisabledOperationException = _ServiceError . hasStatus 409 . hasCode "DisabledAction" --- | An internal error occurred while processing the request. If this problem persists, report an issue from the <http://status.aws.amazon.com/ Service Health Dashboard>.+-- | An internal error occurred while processing the request. If this problem persists, report an issue from the <http://status.aws.amazon.com/ Service Health Dashboard> .+--+-- _InternalException :: AsError a => Getting (First ServiceError) a ServiceError _InternalException = _ServiceError . hasStatus 500 . hasCode "InternalException" -- | The request was rejected because it specified an invalid type definition.+--+-- _InvalidTypeException :: AsError a => Getting (First ServiceError) a ServiceError _InvalidTypeException = _ServiceError . hasStatus 409 . hasCode "InvalidType" -- | The request was rejected because it attempted to reference a resource that does not exist.+--+-- _ResourceNotFoundException :: AsError a => Getting (First ServiceError) a ServiceError _ResourceNotFoundException = _ServiceError . hasStatus 409 . hasCode "ResourceNotFound" -- | The request was rejected because a resource limit has already been met.+--+-- _LimitExceededException :: AsError a => Getting (First ServiceError) a ServiceError _LimitExceededException = _ServiceError . hasStatus 409 . hasCode "LimitExceeded"
gen/Network/AWS/CloudSearch/Types/Product.hs view
@@ -21,8 +21,10 @@ import Network.AWS.Lens import Network.AWS.Prelude --- | The configured access rules for the domain\'s document and search endpoints, and the current status of those rules.+-- | 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 = AccessPoliciesStatus' { _apsOptions :: !Text@@ -33,9 +35,9 @@ -- -- Use one of the following lenses to modify other fields as desired: ----- * 'apsOptions'+-- * 'apsOptions' - Undocumented member. ----- * 'apsStatus'+-- * 'apsStatus' - Undocumented member. accessPoliciesStatus :: Text -- ^ 'apsOptions' -> OptionStatus -- ^ 'apsStatus'@@ -65,6 +67,8 @@ -- | Synonyms, stopwords, and stemming options for an analysis scheme. Includes tokenization dictionary for Japanese. --+--+-- -- /See:/ 'analysisOptions' smart constructor. data AnalysisOptions = AnalysisOptions' { _aoAlgorithmicStemming :: !(Maybe AlgorithmicStemming)@@ -78,15 +82,15 @@ -- -- Use one of the following lenses to modify other fields as desired: ----- * 'aoAlgorithmicStemming'+-- * 'aoAlgorithmicStemming' - The level of algorithmic stemming to perform: @none@ , @minimal@ , @light@ , or @full@ . The available levels vary depending on the language. For more information, see <http://docs.aws.amazon.com/cloudsearch/latest/developerguide/text-processing.html#text-processing-settings Language Specific Text Processing Settings> in the /Amazon CloudSearch Developer Guide/ ----- * 'aoStopwords'+-- * 'aoStopwords' - A JSON array of terms to ignore during indexing and searching. For example, @["a", "an", "the", "of"]@ . The stopwords dictionary must explicitly list each word you want to ignore. Wildcards and regular expressions are not supported. ----- * 'aoJapaneseTokenizationDictionary'+-- * 'aoJapaneseTokenizationDictionary' - A JSON array that contains a collection of terms, tokens, readings and part of speech for Japanese Tokenizaiton. The Japanese tokenization dictionary enables you to override the default tokenization for selected terms. This is only valid for Japanese language fields. ----- * 'aoSynonyms'+-- * 'aoSynonyms' - 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 <http://docs.aws.amazon.com/cloudsearch/latest/developerguide/configuring-analysis-schemes.html#synonyms Synonyms> in the /Amazon CloudSearch Developer Guide/ . ----- * 'aoStemmingDictionary'+-- * 'aoStemmingDictionary' - 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 :: AnalysisOptions analysisOptions =@@ -98,11 +102,11 @@ , _aoStemmingDictionary = Nothing } --- | The level of algorithmic stemming to perform: 'none', 'minimal', 'light', or 'full'. The available levels vary depending on the language. For more information, see <http://docs.aws.amazon.com/cloudsearch/latest/developerguide/text-processing.html#text-processing-settings Language Specific Text Processing Settings> in the /Amazon CloudSearch Developer Guide/+-- | The level of algorithmic stemming to perform: @none@ , @minimal@ , @light@ , or @full@ . The available levels vary depending on the language. For more information, see <http://docs.aws.amazon.com/cloudsearch/latest/developerguide/text-processing.html#text-processing-settings Language Specific Text Processing Settings> in the /Amazon CloudSearch Developer Guide/ aoAlgorithmicStemming :: Lens' AnalysisOptions (Maybe AlgorithmicStemming) aoAlgorithmicStemming = lens _aoAlgorithmicStemming (\ s a -> s{_aoAlgorithmicStemming = a}); --- | 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.+-- | 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) aoStopwords = lens _aoStopwords (\ s a -> s{_aoStopwords = a}); @@ -110,11 +114,11 @@ aoJapaneseTokenizationDictionary :: Lens' AnalysisOptions (Maybe Text) aoJapaneseTokenizationDictionary = lens _aoJapaneseTokenizationDictionary (\ s a -> s{_aoJapaneseTokenizationDictionary = a}); --- | 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 <http://docs.aws.amazon.com/cloudsearch/latest/developerguide/configuring-analysis-schemes.html#synonyms Synonyms> in the /Amazon CloudSearch Developer Guide/.+-- | 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 <http://docs.aws.amazon.com/cloudsearch/latest/developerguide/configuring-analysis-schemes.html#synonyms Synonyms> in the /Amazon CloudSearch Developer Guide/ . aoSynonyms :: Lens' AnalysisOptions (Maybe Text) aoSynonyms = lens _aoSynonyms (\ s a -> s{_aoSynonyms = a}); --- | 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.+-- | 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) aoStemmingDictionary = lens _aoStemmingDictionary (\ s a -> s{_aoStemmingDictionary = a}); @@ -140,8 +144,10 @@ "Synonyms" =: _aoSynonyms, "StemmingDictionary" =: _aoStemmingDictionary] --- | 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'.+-- | 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 = AnalysisScheme' { _asAnalysisOptions :: !(Maybe AnalysisOptions)@@ -153,11 +159,11 @@ -- -- Use one of the following lenses to modify other fields as desired: ----- * 'asAnalysisOptions'+-- * 'asAnalysisOptions' - Undocumented member. ----- * 'asAnalysisSchemeName'+-- * 'asAnalysisSchemeName' - Undocumented member. ----- * 'asAnalysisSchemeLanguage'+-- * 'asAnalysisSchemeLanguage' - Undocumented member. analysisScheme :: Text -- ^ 'asAnalysisSchemeName' -> AnalysisSchemeLanguage -- ^ 'asAnalysisSchemeLanguage'@@ -200,8 +206,10 @@ "AnalysisSchemeLanguage" =: _asAnalysisSchemeLanguage] --- | The status and configuration of an 'AnalysisScheme'.+-- | The status and configuration of an @AnalysisScheme@ . --+--+-- -- /See:/ 'analysisSchemeStatus' smart constructor. data AnalysisSchemeStatus = AnalysisSchemeStatus' { _assOptions :: !AnalysisScheme@@ -212,9 +220,9 @@ -- -- Use one of the following lenses to modify other fields as desired: ----- * 'assOptions'+-- * 'assOptions' - Undocumented member. ----- * 'assStatus'+-- * 'assStatus' - Undocumented member. analysisSchemeStatus :: AnalysisScheme -- ^ 'assOptions' -> OptionStatus -- ^ 'assStatus'@@ -242,8 +250,10 @@ instance NFData AnalysisSchemeStatus --- | The status and configuration of the domain\'s availability options.+-- | The status and configuration of the domain's availability options. --+--+-- -- /See:/ 'availabilityOptionsStatus' smart constructor. data AvailabilityOptionsStatus = AvailabilityOptionsStatus' { _aosOptions :: !Bool@@ -254,9 +264,9 @@ -- -- Use one of the following lenses to modify other fields as desired: ----- * 'aosOptions'+-- * 'aosOptions' - The availability options configured for the domain. ----- * 'aosStatus'+-- * 'aosStatus' - Undocumented member. availabilityOptionsStatus :: Bool -- ^ 'aosOptions' -> OptionStatus -- ^ 'aosStatus'@@ -284,8 +294,10 @@ instance NFData AvailabilityOptionsStatus --- | 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.+-- | 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 = DateArrayOptions' { _daosSourceFields :: !(Maybe Text)@@ -299,15 +311,15 @@ -- -- Use one of the following lenses to modify other fields as desired: ----- * 'daosSourceFields'+-- * 'daosSourceFields' - A list of source fields to map to the field. ----- * 'daosReturnEnabled'+-- * 'daosReturnEnabled' - Whether the contents of the field can be returned in the search results. ----- * 'daosFacetEnabled'+-- * 'daosFacetEnabled' - Whether facet information can be returned for the field. ----- * 'daosSearchEnabled'+-- * 'daosSearchEnabled' - Whether the contents of the field are searchable. ----- * 'daosDefaultValue'+-- * 'daosDefaultValue' - A value to use for the field if the field isn't specified for a document. dateArrayOptions :: DateArrayOptions dateArrayOptions =@@ -335,7 +347,7 @@ daosSearchEnabled :: Lens' DateArrayOptions (Maybe Bool) daosSearchEnabled = lens _daosSearchEnabled (\ s a -> s{_daosSearchEnabled = a}); --- | A value to use for the field if the field isn\'t specified for a document.+-- | A value to use for the field if the field isn't specified for a document. daosDefaultValue :: Lens' DateArrayOptions (Maybe Text) daosDefaultValue = lens _daosDefaultValue (\ s a -> s{_daosDefaultValue = a}); @@ -360,8 +372,10 @@ "SearchEnabled" =: _daosSearchEnabled, "DefaultValue" =: _daosDefaultValue] --- | 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.+-- | 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 = DateOptions' { _doSourceField :: !(Maybe Text)@@ -376,17 +390,17 @@ -- -- Use one of the following lenses to modify other fields as desired: ----- * 'doSourceField'+-- * 'doSourceField' - Undocumented member. ----- * 'doReturnEnabled'+-- * 'doReturnEnabled' - Whether the contents of the field can be returned in the search results. ----- * 'doFacetEnabled'+-- * 'doFacetEnabled' - Whether facet information can be returned for the field. ----- * 'doSearchEnabled'+-- * 'doSearchEnabled' - Whether the contents of the field are searchable. ----- * 'doSortEnabled'+-- * 'doSortEnabled' - Whether the field can be used to sort the search results. ----- * 'doDefaultValue'+-- * 'doDefaultValue' - A value to use for the field if the field isn't specified for a document. dateOptions :: DateOptions dateOptions =@@ -419,7 +433,7 @@ doSortEnabled :: Lens' DateOptions (Maybe Bool) doSortEnabled = lens _doSortEnabled (\ s a -> s{_doSortEnabled = a}); --- | A value to use for the field if the field isn\'t specified for a document.+-- | A value to use for the field if the field isn't specified for a document. doDefaultValue :: Lens' DateOptions (Maybe Text) doDefaultValue = lens _doDefaultValue (\ s a -> s{_doDefaultValue = a}); @@ -448,6 +462,8 @@ -- | Options for a search suggester. --+--+-- -- /See:/ 'documentSuggesterOptions' smart constructor. data DocumentSuggesterOptions = DocumentSuggesterOptions' { _dsoSortExpression :: !(Maybe Text)@@ -459,11 +475,11 @@ -- -- Use one of the following lenses to modify other fields as desired: ----- * 'dsoSortExpression'+-- * 'dsoSortExpression' - An expression that computes a score for each suggestion to control how they are sorted. The scores are rounded to the nearest integer, with a floor of 0 and a ceiling of 2^31-1. A document's relevance score is not computed for suggestions, so sort expressions cannot reference the @_score@ value. To sort suggestions using a numeric field or existing expression, simply specify the name of the field or expression. If no expression is configured for the suggester, the suggestions are sorted with the closest matches listed first. ----- * 'dsoFuzzyMatching'+-- * 'dsoFuzzyMatching' - The level of fuzziness allowed when suggesting matches for a string: @none@ , @low@ , or @high@ . With none, the specified string is treated as an exact prefix. With low, suggestions must differ from the specified string by no more than one character. With high, suggestions can differ by up to two characters. The default is none. ----- * 'dsoSourceField'+-- * 'dsoSourceField' - The name of the index field you want to use for suggestions. documentSuggesterOptions :: Text -- ^ 'dsoSourceField' -> DocumentSuggesterOptions@@ -474,11 +490,11 @@ , _dsoSourceField = pSourceField_ } --- | 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.+-- | 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) dsoSortExpression = lens _dsoSortExpression (\ s a -> s{_dsoSortExpression = a}); --- | 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.+-- | 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) dsoFuzzyMatching = lens _dsoFuzzyMatching (\ s a -> s{_dsoFuzzyMatching = a}); @@ -505,6 +521,8 @@ -- | The current status of the search domain. --+--+-- -- /See:/ 'domainStatus' smart constructor. data DomainStatus = DomainStatus' { _dsSearchInstanceCount :: !(Maybe Nat)@@ -526,31 +544,31 @@ -- -- Use one of the following lenses to modify other fields as desired: ----- * 'dsSearchInstanceCount'+-- * 'dsSearchInstanceCount' - The number of search instances that are available to process search requests. ----- * 'dsSearchInstanceType'+-- * 'dsSearchInstanceType' - The instance type that is being used to process search requests. ----- * 'dsDocService'+-- * 'dsDocService' - The service endpoint for updating documents in a search domain. ----- * 'dsARN'+-- * 'dsARN' - Undocumented member. ----- * 'dsCreated'+-- * 'dsCreated' - True if the search domain is created. It can take several minutes to initialize a domain when 'CreateDomain' is called. Newly created search domains are returned from 'DescribeDomains' with a false value for Created until domain creation is complete. ----- * 'dsSearchService'+-- * 'dsSearchService' - The service endpoint for requesting search results from a search domain. ----- * 'dsLimits'+-- * 'dsLimits' - Undocumented member. ----- * 'dsSearchPartitionCount'+-- * 'dsSearchPartitionCount' - The number of partitions across which the search index is spread. ----- * 'dsDeleted'+-- * 'dsDeleted' - True if the search domain has been deleted. The system must clean up resources dedicated to the search domain when 'DeleteDomain' is called. Newly deleted search domains are returned from 'DescribeDomains' with a true value for IsDeleted for several minutes until resource cleanup is complete. ----- * 'dsProcessing'+-- * 'dsProcessing' - True if processing is being done to activate the current domain configuration. ----- * 'dsDomainId'+-- * 'dsDomainId' - Undocumented member. ----- * 'dsDomainName'+-- * 'dsDomainName' - Undocumented member. ----- * 'dsRequiresIndexDocuments'+-- * 'dsRequiresIndexDocuments' - True if 'IndexDocuments' needs to be called to activate the current domain configuration. domainStatus :: Text -- ^ 'dsDomainId' -> Text -- ^ 'dsDomainName'@@ -589,7 +607,7 @@ dsARN :: Lens' DomainStatus (Maybe Text) dsARN = lens _dsARN (\ s a -> s{_dsARN = a}); --- | 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.+-- | 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) dsCreated = lens _dsCreated (\ s a -> s{_dsCreated = a}); @@ -605,7 +623,7 @@ dsSearchPartitionCount :: Lens' DomainStatus (Maybe Natural) dsSearchPartitionCount = lens _dsSearchPartitionCount (\ s a -> s{_dsSearchPartitionCount = a}) . mapping _Nat; --- | 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.+-- | 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) dsDeleted = lens _dsDeleted (\ s a -> s{_dsDeleted = a}); @@ -621,7 +639,7 @@ dsDomainName :: Lens' DomainStatus Text dsDomainName = lens _dsDomainName (\ s a -> s{_dsDomainName = a}); --- | True if < IndexDocuments> needs to be called to activate the current domain configuration.+-- | True if 'IndexDocuments' needs to be called to activate the current domain configuration. dsRequiresIndexDocuments :: Lens' DomainStatus Bool dsRequiresIndexDocuments = lens _dsRequiresIndexDocuments (\ s a -> s{_dsRequiresIndexDocuments = a}); @@ -646,8 +664,10 @@ instance NFData DomainStatus --- | 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.+-- | 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 = DoubleArrayOptions' { _daoSourceFields :: !(Maybe Text)@@ -661,15 +681,15 @@ -- -- Use one of the following lenses to modify other fields as desired: ----- * 'daoSourceFields'+-- * 'daoSourceFields' - A list of source fields to map to the field. ----- * 'daoReturnEnabled'+-- * 'daoReturnEnabled' - Whether the contents of the field can be returned in the search results. ----- * 'daoFacetEnabled'+-- * 'daoFacetEnabled' - Whether facet information can be returned for the field. ----- * 'daoSearchEnabled'+-- * 'daoSearchEnabled' - Whether the contents of the field are searchable. ----- * 'daoDefaultValue'+-- * 'daoDefaultValue' - A value to use for the field if the field isn't specified for a document. doubleArrayOptions :: DoubleArrayOptions doubleArrayOptions =@@ -697,7 +717,7 @@ daoSearchEnabled :: Lens' DoubleArrayOptions (Maybe Bool) daoSearchEnabled = lens _daoSearchEnabled (\ s a -> s{_daoSearchEnabled = a}); --- | A value to use for the field if the field isn\'t specified for a document.+-- | A value to use for the field if the field isn't specified for a document. daoDefaultValue :: Lens' DoubleArrayOptions (Maybe Double) daoDefaultValue = lens _daoDefaultValue (\ s a -> s{_daoDefaultValue = a}); @@ -722,8 +742,10 @@ "SearchEnabled" =: _daoSearchEnabled, "DefaultValue" =: _daoDefaultValue] --- | 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.+-- | 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 = DoubleOptions' { _dSourceField :: !(Maybe Text)@@ -738,17 +760,17 @@ -- -- Use one of the following lenses to modify other fields as desired: ----- * 'dSourceField'+-- * 'dSourceField' - The name of the source field to map to the field. ----- * 'dReturnEnabled'+-- * 'dReturnEnabled' - Whether the contents of the field can be returned in the search results. ----- * 'dFacetEnabled'+-- * 'dFacetEnabled' - Whether facet information can be returned for the field. ----- * 'dSearchEnabled'+-- * 'dSearchEnabled' - Whether the contents of the field are searchable. ----- * 'dSortEnabled'+-- * 'dSortEnabled' - Whether the field can be used to sort the search results. ----- * 'dDefaultValue'+-- * 'dDefaultValue' - 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 :: DoubleOptions doubleOptions =@@ -781,7 +803,7 @@ dSortEnabled :: Lens' DoubleOptions (Maybe Bool) dSortEnabled = lens _dSortEnabled (\ s a -> s{_dSortEnabled = a}); --- | 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.+-- | 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) dDefaultValue = lens _dDefaultValue (\ s a -> s{_dDefaultValue = a}); @@ -810,6 +832,8 @@ -- | 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 = Expression' { _eExpressionName :: !Text@@ -820,9 +844,9 @@ -- -- Use one of the following lenses to modify other fields as desired: ----- * 'eExpressionName'+-- * 'eExpressionName' - Undocumented member. ----- * 'eExpressionValue'+-- * 'eExpressionValue' - Undocumented member. expression :: Text -- ^ 'eExpressionName' -> Text -- ^ 'eExpressionValue'@@ -856,8 +880,10 @@ ["ExpressionName" =: _eExpressionName, "ExpressionValue" =: _eExpressionValue] --- | The value of an 'Expression' and its current status.+-- | The value of an @Expression@ and its current status. --+--+-- -- /See:/ 'expressionStatus' smart constructor. data ExpressionStatus = ExpressionStatus' { _esOptions :: !Expression@@ -868,9 +894,9 @@ -- -- Use one of the following lenses to modify other fields as desired: ----- * 'esOptions'+-- * 'esOptions' - The expression that is evaluated for sorting while processing a search request. ----- * 'esStatus'+-- * 'esStatus' - Undocumented member. expressionStatus :: Expression -- ^ 'esOptions' -> OptionStatus -- ^ 'esStatus'@@ -898,8 +924,10 @@ instance NFData ExpressionStatus --- | Configuration information for a field in the index, including its name, type, and options. The supported options depend on the 'IndexFieldType'.+-- | 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 = IndexField' { _ifDoubleArrayOptions :: !(Maybe DoubleArrayOptions)@@ -921,31 +949,31 @@ -- -- Use one of the following lenses to modify other fields as desired: ----- * 'ifDoubleArrayOptions'+-- * 'ifDoubleArrayOptions' - Undocumented member. ----- * 'ifDateOptions'+-- * 'ifDateOptions' - Undocumented member. ----- * 'ifTextArrayOptions'+-- * 'ifTextArrayOptions' - Undocumented member. ----- * 'ifDoubleOptions'+-- * 'ifDoubleOptions' - Undocumented member. ----- * 'ifTextOptions'+-- * 'ifTextOptions' - Undocumented member. ----- * 'ifLatLonOptions'+-- * 'ifLatLonOptions' - Undocumented member. ----- * 'ifLiteralArrayOptions'+-- * 'ifLiteralArrayOptions' - Undocumented member. ----- * 'ifIntArrayOptions'+-- * 'ifIntArrayOptions' - Undocumented member. ----- * 'ifDateArrayOptions'+-- * 'ifDateArrayOptions' - Undocumented member. ----- * 'ifIntOptions'+-- * 'ifIntOptions' - Undocumented member. ----- * 'ifLiteralOptions'+-- * 'ifLiteralOptions' - Undocumented member. ----- * 'ifIndexFieldName'+-- * 'ifIndexFieldName' - A string that represents the name of an index field. CloudSearch supports regular index fields as well as dynamic fields. A dynamic field's name defines a pattern that begins or ends with a wildcard. Any document fields that don't map to a regular index field but do match a dynamic field's pattern are configured with the dynamic field's indexing options. Regular field names begin with a letter and can contain the following characters: a-z (lowercase), 0-9, and _ (underscore). Dynamic field names must begin or end with a wildcard (*). The wildcard can also be the only character in a dynamic field name. Multiple wildcards, and wildcards embedded within a string are not supported. The name @score@ is reserved and cannot be used as a field name. To reference a document's ID, you can use the name @_id@ . ----- * 'ifIndexFieldType'+-- * 'ifIndexFieldType' - Undocumented member. indexField :: Text -- ^ 'ifIndexFieldName' -> IndexFieldType -- ^ 'ifIndexFieldType'@@ -1011,11 +1039,7 @@ ifLiteralOptions :: Lens' IndexField (Maybe LiteralOptions) ifLiteralOptions = lens _ifLiteralOptions (\ s a -> s{_ifLiteralOptions = a}); --- | 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'.+-- | 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 ifIndexFieldName = lens _ifIndexFieldName (\ s a -> s{_ifIndexFieldName = a}); @@ -1061,8 +1085,10 @@ "IndexFieldName" =: _ifIndexFieldName, "IndexFieldType" =: _ifIndexFieldType] --- | The value of an 'IndexField' and its current status.+-- | The value of an @IndexField@ and its current status. --+--+-- -- /See:/ 'indexFieldStatus' smart constructor. data IndexFieldStatus = IndexFieldStatus' { _ifsOptions :: !IndexField@@ -1073,9 +1099,9 @@ -- -- Use one of the following lenses to modify other fields as desired: ----- * 'ifsOptions'+-- * 'ifsOptions' - Undocumented member. ----- * 'ifsStatus'+-- * 'ifsStatus' - Undocumented member. indexFieldStatus :: IndexField -- ^ 'ifsOptions' -> OptionStatus -- ^ 'ifsStatus'@@ -1103,8 +1129,10 @@ instance NFData IndexFieldStatus --- | 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.+-- | 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 = IntArrayOptions' { _iaoSourceFields :: !(Maybe Text)@@ -1118,15 +1146,15 @@ -- -- Use one of the following lenses to modify other fields as desired: ----- * 'iaoSourceFields'+-- * 'iaoSourceFields' - A list of source fields to map to the field. ----- * 'iaoReturnEnabled'+-- * 'iaoReturnEnabled' - Whether the contents of the field can be returned in the search results. ----- * 'iaoFacetEnabled'+-- * 'iaoFacetEnabled' - Whether facet information can be returned for the field. ----- * 'iaoSearchEnabled'+-- * 'iaoSearchEnabled' - Whether the contents of the field are searchable. ----- * 'iaoDefaultValue'+-- * 'iaoDefaultValue' - A value to use for the field if the field isn't specified for a document. intArrayOptions :: IntArrayOptions intArrayOptions =@@ -1154,7 +1182,7 @@ iaoSearchEnabled :: Lens' IntArrayOptions (Maybe Bool) iaoSearchEnabled = lens _iaoSearchEnabled (\ s a -> s{_iaoSearchEnabled = a}); --- | A value to use for the field if the field isn\'t specified for a document.+-- | A value to use for the field if the field isn't specified for a document. iaoDefaultValue :: Lens' IntArrayOptions (Maybe Integer) iaoDefaultValue = lens _iaoDefaultValue (\ s a -> s{_iaoDefaultValue = a}); @@ -1179,8 +1207,10 @@ "SearchEnabled" =: _iaoSearchEnabled, "DefaultValue" =: _iaoDefaultValue] --- | Options for a 64-bit signed integer field. Present if 'IndexFieldType' specifies the field is of type 'int'. All options are enabled by default.+-- | 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 = IntOptions' { _ioSourceField :: !(Maybe Text)@@ -1195,17 +1225,17 @@ -- -- Use one of the following lenses to modify other fields as desired: ----- * 'ioSourceField'+-- * 'ioSourceField' - The name of the source field to map to the field. ----- * 'ioReturnEnabled'+-- * 'ioReturnEnabled' - Whether the contents of the field can be returned in the search results. ----- * 'ioFacetEnabled'+-- * 'ioFacetEnabled' - Whether facet information can be returned for the field. ----- * 'ioSearchEnabled'+-- * 'ioSearchEnabled' - Whether the contents of the field are searchable. ----- * 'ioSortEnabled'+-- * 'ioSortEnabled' - Whether the field can be used to sort the search results. ----- * 'ioDefaultValue'+-- * 'ioDefaultValue' - 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 :: IntOptions intOptions =@@ -1238,7 +1268,7 @@ ioSortEnabled :: Lens' IntOptions (Maybe Bool) ioSortEnabled = lens _ioSortEnabled (\ s a -> s{_ioSortEnabled = a}); --- | 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.+-- | 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) ioDefaultValue = lens _ioDefaultValue (\ s a -> s{_ioDefaultValue = a}); @@ -1265,8 +1295,10 @@ "SortEnabled" =: _ioSortEnabled, "DefaultValue" =: _ioDefaultValue] --- | 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.+-- | 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 = LatLonOptions' { _lloSourceField :: !(Maybe Text)@@ -1281,17 +1313,17 @@ -- -- Use one of the following lenses to modify other fields as desired: ----- * 'lloSourceField'+-- * 'lloSourceField' - Undocumented member. ----- * 'lloReturnEnabled'+-- * 'lloReturnEnabled' - Whether the contents of the field can be returned in the search results. ----- * 'lloFacetEnabled'+-- * 'lloFacetEnabled' - Whether facet information can be returned for the field. ----- * 'lloSearchEnabled'+-- * 'lloSearchEnabled' - Whether the contents of the field are searchable. ----- * 'lloSortEnabled'+-- * 'lloSortEnabled' - Whether the field can be used to sort the search results. ----- * 'lloDefaultValue'+-- * 'lloDefaultValue' - A value to use for the field if the field isn't specified for a document. latLonOptions :: LatLonOptions latLonOptions =@@ -1324,7 +1356,7 @@ lloSortEnabled :: Lens' LatLonOptions (Maybe Bool) lloSortEnabled = lens _lloSortEnabled (\ s a -> s{_lloSortEnabled = a}); --- | A value to use for the field if the field isn\'t specified for a document.+-- | A value to use for the field if the field isn't specified for a document. lloDefaultValue :: Lens' LatLonOptions (Maybe Text) lloDefaultValue = lens _lloDefaultValue (\ s a -> s{_lloDefaultValue = a}); @@ -1361,9 +1393,9 @@ -- -- Use one of the following lenses to modify other fields as desired: ----- * 'lMaximumReplicationCount'+-- * 'lMaximumReplicationCount' - Undocumented member. ----- * 'lMaximumPartitionCount'+-- * 'lMaximumPartitionCount' - Undocumented member. limits :: Natural -- ^ 'lMaximumReplicationCount' -> Natural -- ^ 'lMaximumPartitionCount'@@ -1392,8 +1424,10 @@ instance NFData Limits --- | 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.+-- | 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 = LiteralArrayOptions' { _laoSourceFields :: !(Maybe Text)@@ -1407,15 +1441,15 @@ -- -- Use one of the following lenses to modify other fields as desired: ----- * 'laoSourceFields'+-- * 'laoSourceFields' - A list of source fields to map to the field. ----- * 'laoReturnEnabled'+-- * 'laoReturnEnabled' - Whether the contents of the field can be returned in the search results. ----- * 'laoFacetEnabled'+-- * 'laoFacetEnabled' - Whether facet information can be returned for the field. ----- * 'laoSearchEnabled'+-- * 'laoSearchEnabled' - Whether the contents of the field are searchable. ----- * 'laoDefaultValue'+-- * 'laoDefaultValue' - A value to use for the field if the field isn't specified for a document. literalArrayOptions :: LiteralArrayOptions literalArrayOptions =@@ -1443,7 +1477,7 @@ laoSearchEnabled :: Lens' LiteralArrayOptions (Maybe Bool) laoSearchEnabled = lens _laoSearchEnabled (\ s a -> s{_laoSearchEnabled = a}); --- | A value to use for the field if the field isn\'t specified for a document.+-- | A value to use for the field if the field isn't specified for a document. laoDefaultValue :: Lens' LiteralArrayOptions (Maybe Text) laoDefaultValue = lens _laoDefaultValue (\ s a -> s{_laoDefaultValue = a}); @@ -1468,8 +1502,10 @@ "SearchEnabled" =: _laoSearchEnabled, "DefaultValue" =: _laoDefaultValue] --- | Options for literal field. Present if 'IndexFieldType' specifies the field is of type 'literal'. All options are enabled by default.+-- | 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 = LiteralOptions' { _loSourceField :: !(Maybe Text)@@ -1484,17 +1520,17 @@ -- -- Use one of the following lenses to modify other fields as desired: ----- * 'loSourceField'+-- * 'loSourceField' - Undocumented member. ----- * 'loReturnEnabled'+-- * 'loReturnEnabled' - Whether the contents of the field can be returned in the search results. ----- * 'loFacetEnabled'+-- * 'loFacetEnabled' - Whether facet information can be returned for the field. ----- * 'loSearchEnabled'+-- * 'loSearchEnabled' - Whether the contents of the field are searchable. ----- * 'loSortEnabled'+-- * 'loSortEnabled' - Whether the field can be used to sort the search results. ----- * 'loDefaultValue'+-- * 'loDefaultValue' - A value to use for the field if the field isn't specified for a document. literalOptions :: LiteralOptions literalOptions =@@ -1527,7 +1563,7 @@ loSortEnabled :: Lens' LiteralOptions (Maybe Bool) loSortEnabled = lens _loSortEnabled (\ s a -> s{_loSortEnabled = a}); --- | A value to use for the field if the field isn\'t specified for a document.+-- | A value to use for the field if the field isn't specified for a document. loDefaultValue :: Lens' LiteralOptions (Maybe Text) loDefaultValue = lens _loDefaultValue (\ s a -> s{_loDefaultValue = a}); @@ -1556,6 +1592,8 @@ -- | The status of domain configuration option. --+--+-- -- /See:/ 'optionStatus' smart constructor. data OptionStatus = OptionStatus' { _osPendingDeletion :: !(Maybe Bool)@@ -1569,15 +1607,15 @@ -- -- Use one of the following lenses to modify other fields as desired: ----- * 'osPendingDeletion'+-- * 'osPendingDeletion' - Indicates that the option will be deleted once processing is complete. ----- * 'osUpdateVersion'+-- * 'osUpdateVersion' - A unique integer that indicates when this option was last updated. ----- * 'osCreationDate'+-- * 'osCreationDate' - A timestamp for when this option was created. ----- * 'osUpdateDate'+-- * 'osUpdateDate' - A timestamp for when this option was last updated. ----- * 'osState'+-- * 'osState' - 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 :: UTCTime -- ^ 'osCreationDate' -> UTCTime -- ^ 'osUpdateDate'@@ -1608,12 +1646,7 @@ osUpdateDate :: Lens' OptionStatus UTCTime osUpdateDate = lens _osUpdateDate (\ s a -> s{_osUpdateDate = a}) . _Time; --- | 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.+-- | 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 osState = lens _osState (\ s a -> s{_osState = a}); @@ -1631,6 +1664,8 @@ -- | The desired instance type and desired number of replicas of each index partition. --+--+-- -- /See:/ 'scalingParameters' smart constructor. data ScalingParameters = ScalingParameters' { _spDesiredInstanceType :: !(Maybe PartitionInstanceType)@@ -1642,11 +1677,11 @@ -- -- Use one of the following lenses to modify other fields as desired: ----- * 'spDesiredInstanceType'+-- * 'spDesiredInstanceType' - The instance type that you want to preconfigure for your domain. For example, @search.m1.small@ . ----- * 'spDesiredReplicationCount'+-- * 'spDesiredReplicationCount' - The number of replicas you want to preconfigure for each index partition. ----- * 'spDesiredPartitionCount'+-- * 'spDesiredPartitionCount' - The number of partitions you want to preconfigure for your domain. Only valid when you select @m2.2xlarge@ as the desired instance type. scalingParameters :: ScalingParameters scalingParameters =@@ -1656,7 +1691,7 @@ , _spDesiredPartitionCount = Nothing } --- | The instance type that you want to preconfigure for your domain. For example, 'search.m1.small'.+-- | The instance type that you want to preconfigure for your domain. For example, @search.m1.small@ . spDesiredInstanceType :: Lens' ScalingParameters (Maybe PartitionInstanceType) spDesiredInstanceType = lens _spDesiredInstanceType (\ s a -> s{_spDesiredInstanceType = a}); @@ -1664,7 +1699,7 @@ spDesiredReplicationCount :: Lens' ScalingParameters (Maybe Natural) spDesiredReplicationCount = lens _spDesiredReplicationCount (\ s a -> s{_spDesiredReplicationCount = a}) . mapping _Nat; --- | The number of partitions you want to preconfigure for your domain. Only valid when you select 'm2.2xlarge' as the desired instance type.+-- | 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) spDesiredPartitionCount = lens _spDesiredPartitionCount (\ s a -> s{_spDesiredPartitionCount = a}) . mapping _Nat; @@ -1687,8 +1722,10 @@ _spDesiredReplicationCount, "DesiredPartitionCount" =: _spDesiredPartitionCount] --- | The status and configuration of a search domain\'s scaling parameters.+-- | The status and configuration of a search domain's scaling parameters. --+--+-- -- /See:/ 'scalingParametersStatus' smart constructor. data ScalingParametersStatus = ScalingParametersStatus' { _spsOptions :: !ScalingParameters@@ -1699,9 +1736,9 @@ -- -- Use one of the following lenses to modify other fields as desired: ----- * 'spsOptions'+-- * 'spsOptions' - Undocumented member. ----- * 'spsStatus'+-- * 'spsStatus' - Undocumented member. scalingParametersStatus :: ScalingParameters -- ^ 'spsOptions' -> OptionStatus -- ^ 'spsStatus'@@ -1731,6 +1768,8 @@ -- | The endpoint to which service requests can be submitted. --+--+-- -- /See:/ 'serviceEndpoint' smart constructor. newtype ServiceEndpoint = ServiceEndpoint' { _seEndpoint :: Maybe Text@@ -1740,7 +1779,7 @@ -- -- Use one of the following lenses to modify other fields as desired: ----- * 'seEndpoint'+-- * 'seEndpoint' - Undocumented member. serviceEndpoint :: ServiceEndpoint serviceEndpoint =@@ -1759,8 +1798,10 @@ instance NFData ServiceEndpoint --- | 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'.+-- | 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 = Suggester' { _sSuggesterName :: !Text@@ -1771,9 +1812,9 @@ -- -- Use one of the following lenses to modify other fields as desired: ----- * 'sSuggesterName'+-- * 'sSuggesterName' - Undocumented member. ----- * 'sDocumentSuggesterOptions'+-- * 'sDocumentSuggesterOptions' - Undocumented member. suggester :: Text -- ^ 'sSuggesterName' -> DocumentSuggesterOptions -- ^ 'sDocumentSuggesterOptions'@@ -1809,8 +1850,10 @@ "DocumentSuggesterOptions" =: _sDocumentSuggesterOptions] --- | The value of a 'Suggester' and its current status.+-- | The value of a @Suggester@ and its current status. --+--+-- -- /See:/ 'suggesterStatus' smart constructor. data SuggesterStatus = SuggesterStatus' { _ssOptions :: !Suggester@@ -1821,9 +1864,9 @@ -- -- Use one of the following lenses to modify other fields as desired: ----- * 'ssOptions'+-- * 'ssOptions' - Undocumented member. ----- * 'ssStatus'+-- * 'ssStatus' - Undocumented member. suggesterStatus :: Suggester -- ^ 'ssOptions' -> OptionStatus -- ^ 'ssStatus'@@ -1851,8 +1894,10 @@ instance NFData SuggesterStatus --- | 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.+-- | 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 = TextArrayOptions' { _taoSourceFields :: !(Maybe Text)@@ -1866,15 +1911,15 @@ -- -- Use one of the following lenses to modify other fields as desired: ----- * 'taoSourceFields'+-- * 'taoSourceFields' - A list of source fields to map to the field. ----- * 'taoReturnEnabled'+-- * 'taoReturnEnabled' - Whether the contents of the field can be returned in the search results. ----- * 'taoAnalysisScheme'+-- * 'taoAnalysisScheme' - The name of an analysis scheme for a @text-array@ field. ----- * 'taoHighlightEnabled'+-- * 'taoHighlightEnabled' - Whether highlights can be returned for the field. ----- * 'taoDefaultValue'+-- * 'taoDefaultValue' - A value to use for the field if the field isn't specified for a document. textArrayOptions :: TextArrayOptions textArrayOptions =@@ -1894,7 +1939,7 @@ taoReturnEnabled :: Lens' TextArrayOptions (Maybe Bool) taoReturnEnabled = lens _taoReturnEnabled (\ s a -> s{_taoReturnEnabled = a}); --- | The name of an analysis scheme for a 'text-array' field.+-- | The name of an analysis scheme for a @text-array@ field. taoAnalysisScheme :: Lens' TextArrayOptions (Maybe Text) taoAnalysisScheme = lens _taoAnalysisScheme (\ s a -> s{_taoAnalysisScheme = a}); @@ -1902,7 +1947,7 @@ taoHighlightEnabled :: Lens' TextArrayOptions (Maybe Bool) taoHighlightEnabled = lens _taoHighlightEnabled (\ s a -> s{_taoHighlightEnabled = a}); --- | A value to use for the field if the field isn\'t specified for a document.+-- | A value to use for the field if the field isn't specified for a document. taoDefaultValue :: Lens' TextArrayOptions (Maybe Text) taoDefaultValue = lens _taoDefaultValue (\ s a -> s{_taoDefaultValue = a}); @@ -1927,8 +1972,10 @@ "HighlightEnabled" =: _taoHighlightEnabled, "DefaultValue" =: _taoDefaultValue] --- | 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.+-- | 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 = TextOptions' { _toSourceField :: !(Maybe Text)@@ -1943,17 +1990,17 @@ -- -- Use one of the following lenses to modify other fields as desired: ----- * 'toSourceField'+-- * 'toSourceField' - Undocumented member. ----- * 'toReturnEnabled'+-- * 'toReturnEnabled' - Whether the contents of the field can be returned in the search results. ----- * 'toAnalysisScheme'+-- * 'toAnalysisScheme' - The name of an analysis scheme for a @text@ field. ----- * 'toHighlightEnabled'+-- * 'toHighlightEnabled' - Whether highlights can be returned for the field. ----- * 'toSortEnabled'+-- * 'toSortEnabled' - Whether the field can be used to sort the search results. ----- * 'toDefaultValue'+-- * 'toDefaultValue' - A value to use for the field if the field isn't specified for a document. textOptions :: TextOptions textOptions =@@ -1974,7 +2021,7 @@ toReturnEnabled :: Lens' TextOptions (Maybe Bool) toReturnEnabled = lens _toReturnEnabled (\ s a -> s{_toReturnEnabled = a}); --- | The name of an analysis scheme for a 'text' field.+-- | The name of an analysis scheme for a @text@ field. toAnalysisScheme :: Lens' TextOptions (Maybe Text) toAnalysisScheme = lens _toAnalysisScheme (\ s a -> s{_toAnalysisScheme = a}); @@ -1986,7 +2033,7 @@ toSortEnabled :: Lens' TextOptions (Maybe Bool) toSortEnabled = lens _toSortEnabled (\ s a -> s{_toSortEnabled = a}); --- | A value to use for the field if the field isn\'t specified for a document.+-- | A value to use for the field if the field isn't specified for a document. toDefaultValue :: Lens' TextOptions (Maybe Text) toDefaultValue = lens _toDefaultValue (\ s a -> s{_toDefaultValue = a});
gen/Network/AWS/CloudSearch/Types/Sum.hs view
@@ -51,7 +51,9 @@ instance FromXML AlgorithmicStemming where parseXML = parseXMLText "AlgorithmicStemming" --- | An <http://tools.ietf.org/html/rfc4646 IETF RFC 4646> language code or 'mul' for multiple languages.+-- | An <http://tools.ietf.org/html/rfc4646 IETF RFC 4646> language code or @mul@ for multiple languages.+--+-- data AnalysisSchemeLanguage = AR | BG@@ -177,7 +179,9 @@ instance FromXML AnalysisSchemeLanguage where parseXML = parseXMLText "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 <http://docs.aws.amazon.com/cloudsearch/latest/developerguide/configuring-index-fields.html Configuring Index Fields> in the /Amazon CloudSearch Developer Guide/.+-- | The type of field. The valid options for a field depend on the field type. For more information about the supported field types, see <http://docs.aws.amazon.com/cloudsearch/latest/developerguide/configuring-index-fields.html Configuring Index Fields> in the /Amazon CloudSearch Developer Guide/ .+--+-- data IndexFieldType = Date | DateArray@@ -233,10 +237,9 @@ -- | 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.+--+-- * 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 | FailedToValidate@@ -269,7 +272,9 @@ instance FromXML OptionState where parseXML = parseXMLText "OptionState" --- | The instance type (such as 'search.m1.small') on which an index partition is hosted.+-- | The instance type (such as @search.m1.small@ ) on which an index partition is hosted.+--+-- data PartitionInstanceType = Search_M1_Large | Search_M1_Small
gen/Network/AWS/CloudSearch/UpdateAvailabilityOptions.hs view
@@ -18,7 +18,9 @@ -- Stability : auto-generated -- Portability : non-portable (GHC extensions) ----- 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 <http://docs.aws.amazon.com/cloudsearch/latest/developerguide/configuring-availability-options.html Configuring Availability Options> in the /Amazon CloudSearch Developer Guide/.+-- 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 <http://docs.aws.amazon.com/cloudsearch/latest/developerguide/configuring-availability-options.html Configuring Availability Options> in the /Amazon CloudSearch Developer Guide/ .+--+-- module Network.AWS.CloudSearch.UpdateAvailabilityOptions ( -- * Creating a Request@@ -43,8 +45,10 @@ import Network.AWS.Request import Network.AWS.Response --- | Container for the parameters to the 'UpdateAvailabilityOptions' operation. Specifies the name of the domain you want to update and the Multi-AZ availability option.+-- | 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 = UpdateAvailabilityOptions' { _uaoDomainName :: !Text@@ -55,9 +59,9 @@ -- -- Use one of the following lenses to modify other fields as desired: ----- * 'uaoDomainName'+-- * 'uaoDomainName' - Undocumented member. ----- * 'uaoMultiAZ'+-- * 'uaoMultiAZ' - 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@ . updateAvailabilityOptions :: Text -- ^ 'uaoDomainName' -> Bool -- ^ 'uaoMultiAZ'@@ -72,7 +76,7 @@ uaoDomainName :: Lens' UpdateAvailabilityOptions Text uaoDomainName = lens _uaoDomainName (\ s a -> s{_uaoDomainName = a}); --- | 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'.+-- | 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 uaoMultiAZ = lens _uaoMultiAZ (\ s a -> s{_uaoMultiAZ = a}); @@ -106,8 +110,10 @@ "DomainName" =: _uaoDomainName, "MultiAZ" =: _uaoMultiAZ] --- | The result of a 'UpdateAvailabilityOptions' request. Contains the status of the domain\'s availability options.+-- | The result of a @UpdateAvailabilityOptions@ request. Contains the status of the domain's availability options. --+--+-- -- /See:/ 'updateAvailabilityOptionsResponse' smart constructor. data UpdateAvailabilityOptionsResponse = UpdateAvailabilityOptionsResponse' { _uaorsAvailabilityOptions :: !(Maybe AvailabilityOptionsStatus)@@ -118,9 +124,9 @@ -- -- Use one of the following lenses to modify other fields as desired: ----- * 'uaorsAvailabilityOptions'+-- * 'uaorsAvailabilityOptions' - The newly-configured availability options. Indicates whether Multi-AZ is enabled for the domain. ----- * 'uaorsResponseStatus'+-- * 'uaorsResponseStatus' - -- | The response status code. updateAvailabilityOptionsResponse :: Int -- ^ 'uaorsResponseStatus' -> UpdateAvailabilityOptionsResponse@@ -134,7 +140,7 @@ uaorsAvailabilityOptions :: Lens' UpdateAvailabilityOptionsResponse (Maybe AvailabilityOptionsStatus) uaorsAvailabilityOptions = lens _uaorsAvailabilityOptions (\ s a -> s{_uaorsAvailabilityOptions = a}); --- | The response status code.+-- | -- | The response status code. uaorsResponseStatus :: Lens' UpdateAvailabilityOptionsResponse Int uaorsResponseStatus = lens _uaorsResponseStatus (\ s a -> s{_uaorsResponseStatus = a});
gen/Network/AWS/CloudSearch/UpdateScalingParameters.hs view
@@ -18,7 +18,9 @@ -- Stability : auto-generated -- Portability : non-portable (GHC extensions) ----- 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 <http://docs.aws.amazon.com/cloudsearch/latest/developerguide/configuring-scaling-options.html Configuring Scaling Options> in the /Amazon CloudSearch Developer Guide/.+-- 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 <http://docs.aws.amazon.com/cloudsearch/latest/developerguide/configuring-scaling-options.html Configuring Scaling Options> in the /Amazon CloudSearch Developer Guide/ .+--+-- module Network.AWS.CloudSearch.UpdateScalingParameters ( -- * Creating a Request@@ -43,8 +45,10 @@ import Network.AWS.Request import Network.AWS.Response --- | 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.+-- | 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 = UpdateScalingParameters' { _uspDomainName :: !Text@@ -55,9 +59,9 @@ -- -- Use one of the following lenses to modify other fields as desired: ----- * 'uspDomainName'+-- * 'uspDomainName' - Undocumented member. ----- * 'uspScalingParameters'+-- * 'uspScalingParameters' - Undocumented member. updateScalingParameters :: Text -- ^ 'uspDomainName' -> ScalingParameters -- ^ 'uspScalingParameters'@@ -105,8 +109,10 @@ "DomainName" =: _uspDomainName, "ScalingParameters" =: _uspScalingParameters] --- | The result of a 'UpdateScalingParameters' request. Contains the status of the newly-configured scaling parameters.+-- | The result of a @UpdateScalingParameters@ request. Contains the status of the newly-configured scaling parameters. --+--+-- -- /See:/ 'updateScalingParametersResponse' smart constructor. data UpdateScalingParametersResponse = UpdateScalingParametersResponse' { _usprsResponseStatus :: !Int@@ -117,9 +123,9 @@ -- -- Use one of the following lenses to modify other fields as desired: ----- * 'usprsResponseStatus'+-- * 'usprsResponseStatus' - -- | The response status code. ----- * 'usprsScalingParameters'+-- * 'usprsScalingParameters' - Undocumented member. updateScalingParametersResponse :: Int -- ^ 'usprsResponseStatus' -> ScalingParametersStatus -- ^ 'usprsScalingParameters'@@ -130,7 +136,7 @@ , _usprsScalingParameters = pScalingParameters_ } --- | The response status code.+-- | -- | The response status code. usprsResponseStatus :: Lens' UpdateScalingParametersResponse Int usprsResponseStatus = lens _usprsResponseStatus (\ s a -> s{_usprsResponseStatus = a});
gen/Network/AWS/CloudSearch/UpdateServiceAccessPolicies.hs view
@@ -18,7 +18,9 @@ -- Stability : auto-generated -- Portability : non-portable (GHC extensions) ----- Configures the access rules that control access to the domain\'s document and search endpoints. For more information, see <http://docs.aws.amazon.com/cloudsearch/latest/developerguide/configuring-access.html Configuring Access for an Amazon CloudSearch Domain>.+-- Configures the access rules that control access to the domain's document and search endpoints. For more information, see <http://docs.aws.amazon.com/cloudsearch/latest/developerguide/configuring-access.html Configuring Access for an Amazon CloudSearch Domain> .+--+-- module Network.AWS.CloudSearch.UpdateServiceAccessPolicies ( -- * Creating a Request@@ -43,8 +45,10 @@ import Network.AWS.Request import Network.AWS.Response --- | 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.+-- | 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 = UpdateServiceAccessPolicies' { _usapDomainName :: !Text@@ -55,9 +59,9 @@ -- -- Use one of the following lenses to modify other fields as desired: ----- * 'usapDomainName'+-- * 'usapDomainName' - Undocumented member. ----- * 'usapAccessPolicies'+-- * 'usapAccessPolicies' - The access rules you want to configure. These rules replace any existing rules. updateServiceAccessPolicies :: Text -- ^ 'usapDomainName' -> Text -- ^ 'usapAccessPolicies'@@ -106,8 +110,10 @@ "DomainName" =: _usapDomainName, "AccessPolicies" =: _usapAccessPolicies] --- | The result of an 'UpdateServiceAccessPolicies' request. Contains the new access policies.+-- | The result of an @UpdateServiceAccessPolicies@ request. Contains the new access policies. --+--+-- -- /See:/ 'updateServiceAccessPoliciesResponse' smart constructor. data UpdateServiceAccessPoliciesResponse = UpdateServiceAccessPoliciesResponse' { _usaprsResponseStatus :: !Int@@ -118,9 +124,9 @@ -- -- Use one of the following lenses to modify other fields as desired: ----- * 'usaprsResponseStatus'+-- * 'usaprsResponseStatus' - -- | The response status code. ----- * 'usaprsAccessPolicies'+-- * 'usaprsAccessPolicies' - The access rules configured for the domain. updateServiceAccessPoliciesResponse :: Int -- ^ 'usaprsResponseStatus' -> AccessPoliciesStatus -- ^ 'usaprsAccessPolicies'@@ -131,7 +137,7 @@ , _usaprsAccessPolicies = pAccessPolicies_ } --- | The response status code.+-- | -- | The response status code. usaprsResponseStatus :: Lens' UpdateServiceAccessPoliciesResponse Int usaprsResponseStatus = lens _usaprsResponseStatus (\ s a -> s{_usaprsResponseStatus = a});