amazonka-elasticsearch 1.4.4 → 1.4.5
raw patch · 16 files changed
+273/−182 lines, 16 filesdep ~amazonka-coredep ~amazonka-elasticsearchdep ~amazonka-testPVP: major bump suggested
API removals or changes: PVP suggests a major version bump
Dependency ranges changed: amazonka-core, amazonka-elasticsearch, amazonka-test
API changes (from Hackage documentation)
- Network.AWS.ElasticSearch.AddTags: instance Data.Aeson.Types.Class.ToJSON Network.AWS.ElasticSearch.AddTags.AddTags
- Network.AWS.ElasticSearch.CreateElasticsearchDomain: instance Data.Aeson.Types.Class.ToJSON Network.AWS.ElasticSearch.CreateElasticsearchDomain.CreateElasticsearchDomain
- Network.AWS.ElasticSearch.DescribeElasticsearchDomains: instance Data.Aeson.Types.Class.ToJSON Network.AWS.ElasticSearch.DescribeElasticsearchDomains.DescribeElasticsearchDomains
- Network.AWS.ElasticSearch.RemoveTags: instance Data.Aeson.Types.Class.ToJSON Network.AWS.ElasticSearch.RemoveTags.RemoveTags
- Network.AWS.ElasticSearch.UpdateElasticsearchDomainConfig: instance Data.Aeson.Types.Class.ToJSON Network.AWS.ElasticSearch.UpdateElasticsearchDomainConfig.UpdateElasticsearchDomainConfig
+ Network.AWS.ElasticSearch.AddTags: instance Data.Aeson.Types.ToJSON.ToJSON Network.AWS.ElasticSearch.AddTags.AddTags
+ Network.AWS.ElasticSearch.CreateElasticsearchDomain: instance Data.Aeson.Types.ToJSON.ToJSON Network.AWS.ElasticSearch.CreateElasticsearchDomain.CreateElasticsearchDomain
+ Network.AWS.ElasticSearch.DescribeElasticsearchDomains: instance Data.Aeson.Types.ToJSON.ToJSON Network.AWS.ElasticSearch.DescribeElasticsearchDomains.DescribeElasticsearchDomains
+ Network.AWS.ElasticSearch.RemoveTags: instance Data.Aeson.Types.ToJSON.ToJSON Network.AWS.ElasticSearch.RemoveTags.RemoveTags
+ Network.AWS.ElasticSearch.UpdateElasticsearchDomainConfig: instance Data.Aeson.Types.ToJSON.ToJSON Network.AWS.ElasticSearch.UpdateElasticsearchDomainConfig.UpdateElasticsearchDomainConfig
Files
- README.md +9/−10
- amazonka-elasticsearch.cabal +10/−15
- gen/Network/AWS/ElasticSearch.hs +3/−2
- gen/Network/AWS/ElasticSearch/AddTags.hs +9/−5
- gen/Network/AWS/ElasticSearch/CreateElasticsearchDomain.hs +18/−14
- gen/Network/AWS/ElasticSearch/DeleteElasticsearchDomain.hs +12/−6
- gen/Network/AWS/ElasticSearch/DescribeElasticsearchDomain.hs +12/−6
- gen/Network/AWS/ElasticSearch/DescribeElasticsearchDomainConfig.hs +13/−7
- gen/Network/AWS/ElasticSearch/DescribeElasticsearchDomains.hs +13/−7
- gen/Network/AWS/ElasticSearch/ListDomainNames.hs +9/−5
- gen/Network/AWS/ElasticSearch/ListTags.hs +14/−8
- gen/Network/AWS/ElasticSearch/RemoveTags.hs +9/−5
- gen/Network/AWS/ElasticSearch/Types.hs +18/−2
- gen/Network/AWS/ElasticSearch/Types/Product.hs +99/−74
- gen/Network/AWS/ElasticSearch/Types/Sum.hs +6/−3
- gen/Network/AWS/ElasticSearch/UpdateElasticsearchDomainConfig.hs +19/−13
README.md view
@@ -8,28 +8,27 @@ ## Version -`1.4.4`+`1.4.5` ## Description -Amazon Elasticsearch Configuration Service--Use the Amazon Elasticsearch configuration API to create, configure, and manage Elasticsearch domains.--The endpoint for configuration service requests is region-specific: es./region/.amazonaws.com. For example, es.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#elasticsearch-service-regions Regions and Endpoints>.- Documentation is available via [Hackage](http://hackage.haskell.org/package/amazonka-elasticsearch) 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.ElasticSearch](http://hackage.haskell.org/package/amazonka-elasticsearch/docs/Network-AWS-ElasticSearch.html)+or [the AWS documentation](https://aws.amazon.com/documentation/) to get started.+ ## Contribute
amazonka-elasticsearch.cabal view
@@ -1,5 +1,5 @@ name: amazonka-elasticsearch-version: 1.4.4+version: 1.4.5 synopsis: Amazon Elasticsearch Service 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 Elasticsearch Configuration Service-- Use the Amazon Elasticsearch configuration API to create, configure, and manage Elasticsearch domains.-- The endpoint for configuration service requests is region-specific: es./region/.amazonaws.com. For example, es.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#elasticsearch-service-regions 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.ElasticSearch" or <https://aws.amazon.com/documentation/ the AWS Documentation>+ See "Network.AWS.ElasticSearch" or <https://aws.amazon.com/documentation/ the AWS documentation> to get started. source-repository head@@ -63,7 +58,7 @@ , Network.AWS.ElasticSearch.Types.Sum build-depends:- amazonka-core == 1.4.4.*+ amazonka-core == 1.4.5.* , base >= 4.7 && < 5 test-suite amazonka-elasticsearch-test@@ -83,9 +78,9 @@ , Test.AWS.ElasticSearch.Internal build-depends:- amazonka-core == 1.4.4.*- , amazonka-test == 1.4.4.*- , amazonka-elasticsearch == 1.4.4.*+ amazonka-core == 1.4.5.*+ , amazonka-test == 1.4.5.*+ , amazonka-elasticsearch == 1.4.5.* , base , bytestring , tasty
gen/Network/AWS/ElasticSearch.hs view
@@ -11,11 +11,12 @@ -- Stability : auto-generated -- Portability : non-portable (GHC extensions) ----- Amazon Elasticsearch Configuration Service+-- __Amazon Elasticsearch Configuration Service__ -- -- Use the Amazon Elasticsearch configuration API to create, configure, and manage Elasticsearch domains. ----- The endpoint for configuration service requests is region-specific: es./region/.amazonaws.com. For example, es.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#elasticsearch-service-regions Regions and Endpoints>.+-- The endpoint for configuration service requests is region-specific: es./region/ .amazonaws.com. For example, es.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#elasticsearch-service-regions Regions and Endpoints> .+-- module Network.AWS.ElasticSearch ( -- * Service Configuration
gen/Network/AWS/ElasticSearch/AddTags.hs view
@@ -19,6 +19,8 @@ -- Portability : non-portable (GHC extensions) -- -- Attaches tags to an existing Elasticsearch domain. Tags are a set of case-sensitive key value pairs. An Elasticsearch domain may have up to 10 tags. See <http://docs.aws.amazon.com/elasticsearch-service/latest/developerguide/es-managedomains.html#es-managedomains-awsresorcetagging Tagging Amazon Elasticsearch Service Domains for more information.>+--+-- module Network.AWS.ElasticSearch.AddTags ( -- * Creating a Request@@ -40,8 +42,10 @@ import Network.AWS.Request import Network.AWS.Response --- | Container for the parameters to the 'AddTags' operation. Specify the tags that you want to attach to the Elasticsearch domain.+-- | Container for the parameters to the @'AddTags' @ operation. Specify the tags that you want to attach to the Elasticsearch domain. --+--+-- -- /See:/ 'addTags' smart constructor. data AddTags = AddTags' { _atARN :: !Text@@ -52,9 +56,9 @@ -- -- Use one of the following lenses to modify other fields as desired: ----- * 'atARN'+-- * 'atARN' - Specify the @ARN@ for which you want to add the tags. ----- * 'atTagList'+-- * 'atTagList' - List of @Tag@ that need to be added for the Elasticsearch domain. addTags :: Text -- ^ 'atARN' -> AddTags@@ -64,11 +68,11 @@ , _atTagList = mempty } --- | Specify the 'ARN' for which you want to add the tags.+-- | Specify the @ARN@ for which you want to add the tags. atARN :: Lens' AddTags Text atARN = lens _atARN (\ s a -> s{_atARN = a}); --- | List of 'Tag' that need to be added for the Elasticsearch domain.+-- | List of @Tag@ that need to be added for the Elasticsearch domain. atTagList :: Lens' AddTags [Tag] atTagList = lens _atTagList (\ s a -> s{_atTagList = a}) . _Coerce;
gen/Network/AWS/ElasticSearch/CreateElasticsearchDomain.hs view
@@ -18,7 +18,9 @@ -- Stability : auto-generated -- Portability : non-portable (GHC extensions) ----- Creates a new Elasticsearch domain. For more information, see <http://docs.aws.amazon.com/elasticsearch-service/latest/developerguide/es-createupdatedomains.html#es-createdomains Creating Elasticsearch Domains> in the /Amazon Elasticsearch Service Developer Guide/.+-- Creates a new Elasticsearch domain. For more information, see <http://docs.aws.amazon.com/elasticsearch-service/latest/developerguide/es-createupdatedomains.html#es-createdomains Creating Elasticsearch Domains> in the /Amazon Elasticsearch Service Developer Guide/ .+--+-- module Network.AWS.ElasticSearch.CreateElasticsearchDomain ( -- * Creating a Request@@ -63,19 +65,19 @@ -- -- Use one of the following lenses to modify other fields as desired: ----- * 'cedEBSOptions'+-- * 'cedEBSOptions' - Options to enable, disable and specify the type and size of EBS storage volumes. ----- * 'cedAccessPolicies'+-- * 'cedAccessPolicies' - IAM access policy as a JSON-formatted string. ----- * 'cedElasticsearchClusterConfig'+-- * 'cedElasticsearchClusterConfig' - Configuration options for an Elasticsearch domain. Specifies the instance type and number of instances in the domain cluster. ----- * 'cedSnapshotOptions'+-- * 'cedSnapshotOptions' - Option to set time, in UTC format, of the daily automated snapshot. Default value is 0 hours. ----- * 'cedAdvancedOptions'+-- * 'cedAdvancedOptions' - Option to allow references to indices in an HTTP request body. Must be @false@ when configuring access to individual sub-resources. By default, the value is @true@ . See <http://docs.aws.amazon.com/elasticsearch-service/latest/developerguide/es-createupdatedomains.html#es-createdomain-configure-advanced-options Configuration Advanced Options> for more information. ----- * 'cedElasticsearchVersion'+-- * 'cedElasticsearchVersion' - String of format X.Y to specify version for the Elasticsearch domain eg. "1.5" or "2.3". For more information, see <http://docs.aws.amazon.com/elasticsearch-service/latest/developerguide/es-createupdatedomains.html#es-createdomains Creating Elasticsearch Domains> in the /Amazon Elasticsearch Service Developer Guide/ . ----- * 'cedDomainName'+-- * 'cedDomainName' - The name of the Elasticsearch domain that you are creating. Domain names are unique across the domains owned by an account within an AWS region. Domain names must start with a letter or number and can contain the following characters: a-z (lowercase), 0-9, and - (hyphen). createElasticsearchDomain :: Text -- ^ 'cedDomainName' -> CreateElasticsearchDomain@@ -106,11 +108,11 @@ cedSnapshotOptions :: Lens' CreateElasticsearchDomain (Maybe SnapshotOptions) cedSnapshotOptions = lens _cedSnapshotOptions (\ s a -> s{_cedSnapshotOptions = a}); --- | Option to allow references to indices in an HTTP request body. Must be 'false' when configuring access to individual sub-resources. By default, the value is 'true'. See <http://docs.aws.amazon.com/elasticsearch-service/latest/developerguide/es-createupdatedomains.html#es-createdomain-configure-advanced-options Configuration Advanced Options> for more information.+-- | Option to allow references to indices in an HTTP request body. Must be @false@ when configuring access to individual sub-resources. By default, the value is @true@ . See <http://docs.aws.amazon.com/elasticsearch-service/latest/developerguide/es-createupdatedomains.html#es-createdomain-configure-advanced-options Configuration Advanced Options> for more information. cedAdvancedOptions :: Lens' CreateElasticsearchDomain (HashMap Text Text) cedAdvancedOptions = lens _cedAdvancedOptions (\ s a -> s{_cedAdvancedOptions = a}) . _Default . _Map; --- | String of format X.Y to specify version for the Elasticsearch domain eg. \"1.5\" or \"2.3\". For more information, see <http://docs.aws.amazon.com/elasticsearch-service/latest/developerguide/es-createupdatedomains.html#es-createdomains Creating Elasticsearch Domains> in the /Amazon Elasticsearch Service Developer Guide/.+-- | String of format X.Y to specify version for the Elasticsearch domain eg. "1.5" or "2.3". For more information, see <http://docs.aws.amazon.com/elasticsearch-service/latest/developerguide/es-createupdatedomains.html#es-createdomains Creating Elasticsearch Domains> in the /Amazon Elasticsearch Service Developer Guide/ . cedElasticsearchVersion :: Lens' CreateElasticsearchDomain (Maybe Text) cedElasticsearchVersion = lens _cedElasticsearchVersion (\ s a -> s{_cedElasticsearchVersion = a}); @@ -155,8 +157,10 @@ instance ToQuery CreateElasticsearchDomain where toQuery = const mempty --- | The result of a 'CreateElasticsearchDomain' operation. Contains the status of the newly created Elasticsearch domain.+-- | The result of a @CreateElasticsearchDomain@ operation. Contains the status of the newly created Elasticsearch domain. --+--+-- -- /See:/ 'createElasticsearchDomainResponse' smart constructor. data CreateElasticsearchDomainResponse = CreateElasticsearchDomainResponse' { _cedrsDomainStatus :: !(Maybe ElasticsearchDomainStatus)@@ -167,9 +171,9 @@ -- -- Use one of the following lenses to modify other fields as desired: ----- * 'cedrsDomainStatus'+-- * 'cedrsDomainStatus' - The status of the newly created Elasticsearch domain. ----- * 'cedrsResponseStatus'+-- * 'cedrsResponseStatus' - -- | The response status code. createElasticsearchDomainResponse :: Int -- ^ 'cedrsResponseStatus' -> CreateElasticsearchDomainResponse@@ -183,7 +187,7 @@ cedrsDomainStatus :: Lens' CreateElasticsearchDomainResponse (Maybe ElasticsearchDomainStatus) cedrsDomainStatus = lens _cedrsDomainStatus (\ s a -> s{_cedrsDomainStatus = a}); --- | The response status code.+-- | -- | The response status code. cedrsResponseStatus :: Lens' CreateElasticsearchDomainResponse Int cedrsResponseStatus = lens _cedrsResponseStatus (\ s a -> s{_cedrsResponseStatus = a});
gen/Network/AWS/ElasticSearch/DeleteElasticsearchDomain.hs view
@@ -19,6 +19,8 @@ -- Portability : non-portable (GHC extensions) -- -- Permanently deletes the specified Elasticsearch domain and all of its data. Once a domain is deleted, it cannot be recovered.+--+-- module Network.AWS.ElasticSearch.DeleteElasticsearchDomain ( -- * Creating a Request@@ -42,8 +44,10 @@ import Network.AWS.Request import Network.AWS.Response --- | Container for the parameters to the 'DeleteElasticsearchDomain' operation. Specifies the name of the Elasticsearch domain that you want to delete.+-- | Container for the parameters to the @'DeleteElasticsearchDomain' @ operation. Specifies the name of the Elasticsearch domain that you want to delete. --+--+-- -- /See:/ 'deleteElasticsearchDomain' smart constructor. newtype DeleteElasticsearchDomain = DeleteElasticsearchDomain' { _dDomainName :: Text@@ -53,7 +57,7 @@ -- -- Use one of the following lenses to modify other fields as desired: ----- * 'dDomainName'+-- * 'dDomainName' - The name of the Elasticsearch domain that you want to permanently delete. deleteElasticsearchDomain :: Text -- ^ 'dDomainName' -> DeleteElasticsearchDomain@@ -91,8 +95,10 @@ instance ToQuery DeleteElasticsearchDomain where toQuery = const mempty --- | The result of a 'DeleteElasticsearchDomain' request. Contains the status of the pending deletion, or no status if the domain and all of its resources have been deleted.+-- | The result of a @DeleteElasticsearchDomain@ request. Contains the status of the pending deletion, or no status if the domain and all of its resources have been deleted. --+--+-- -- /See:/ 'deleteElasticsearchDomainResponse' smart constructor. data DeleteElasticsearchDomainResponse = DeleteElasticsearchDomainResponse' { _delrsDomainStatus :: !(Maybe ElasticsearchDomainStatus)@@ -103,9 +109,9 @@ -- -- Use one of the following lenses to modify other fields as desired: ----- * 'delrsDomainStatus'+-- * 'delrsDomainStatus' - The status of the Elasticsearch domain being deleted. ----- * 'delrsResponseStatus'+-- * 'delrsResponseStatus' - -- | The response status code. deleteElasticsearchDomainResponse :: Int -- ^ 'delrsResponseStatus' -> DeleteElasticsearchDomainResponse@@ -119,7 +125,7 @@ delrsDomainStatus :: Lens' DeleteElasticsearchDomainResponse (Maybe ElasticsearchDomainStatus) delrsDomainStatus = lens _delrsDomainStatus (\ s a -> s{_delrsDomainStatus = a}); --- | The response status code.+-- | -- | The response status code. delrsResponseStatus :: Lens' DeleteElasticsearchDomainResponse Int delrsResponseStatus = lens _delrsResponseStatus (\ s a -> s{_delrsResponseStatus = a});
gen/Network/AWS/ElasticSearch/DescribeElasticsearchDomain.hs view
@@ -19,6 +19,8 @@ -- Portability : non-portable (GHC extensions) -- -- Returns domain configuration information about the specified Elasticsearch domain, including the domain ID, domain endpoint, and domain ARN.+--+-- module Network.AWS.ElasticSearch.DescribeElasticsearchDomain ( -- * Creating a Request@@ -42,8 +44,10 @@ import Network.AWS.Request import Network.AWS.Response --- | Container for the parameters to the 'DescribeElasticsearchDomain' operation.+-- | Container for the parameters to the @'DescribeElasticsearchDomain' @ operation. --+--+-- -- /See:/ 'describeElasticsearchDomain' smart constructor. newtype DescribeElasticsearchDomain = DescribeElasticsearchDomain' { _dedDomainName :: Text@@ -53,7 +57,7 @@ -- -- Use one of the following lenses to modify other fields as desired: ----- * 'dedDomainName'+-- * 'dedDomainName' - The name of the Elasticsearch domain for which you want information. describeElasticsearchDomain :: Text -- ^ 'dedDomainName' -> DescribeElasticsearchDomain@@ -91,8 +95,10 @@ instance ToQuery DescribeElasticsearchDomain where toQuery = const mempty --- | The result of a 'DescribeElasticsearchDomain' request. Contains the status of the domain specified in the request.+-- | The result of a @DescribeElasticsearchDomain@ request. Contains the status of the domain specified in the request. --+--+-- -- /See:/ 'describeElasticsearchDomainResponse' smart constructor. data DescribeElasticsearchDomainResponse = DescribeElasticsearchDomainResponse' { _dedrsResponseStatus :: !Int@@ -103,9 +109,9 @@ -- -- Use one of the following lenses to modify other fields as desired: ----- * 'dedrsResponseStatus'+-- * 'dedrsResponseStatus' - -- | The response status code. ----- * 'dedrsDomainStatus'+-- * 'dedrsDomainStatus' - The current status of the Elasticsearch domain. describeElasticsearchDomainResponse :: Int -- ^ 'dedrsResponseStatus' -> ElasticsearchDomainStatus -- ^ 'dedrsDomainStatus'@@ -116,7 +122,7 @@ , _dedrsDomainStatus = pDomainStatus_ } --- | The response status code.+-- | -- | The response status code. dedrsResponseStatus :: Lens' DescribeElasticsearchDomainResponse Int dedrsResponseStatus = lens _dedrsResponseStatus (\ s a -> s{_dedrsResponseStatus = a});
gen/Network/AWS/ElasticSearch/DescribeElasticsearchDomainConfig.hs view
@@ -19,6 +19,8 @@ -- Portability : non-portable (GHC extensions) -- -- Provides cluster configuration information about the specified Elasticsearch domain, such as the state, creation date, update version, and update date for cluster options.+--+-- module Network.AWS.ElasticSearch.DescribeElasticsearchDomainConfig ( -- * Creating a Request@@ -42,8 +44,10 @@ import Network.AWS.Request import Network.AWS.Response --- | Container for the parameters to the 'DescribeElasticsearchDomainConfig' operation. Specifies the domain name for which you want configuration information.+-- | Container for the parameters to the @DescribeElasticsearchDomainConfig@ operation. Specifies the domain name for which you want configuration information. --+--+-- -- /See:/ 'describeElasticsearchDomainConfig' smart constructor. newtype DescribeElasticsearchDomainConfig = DescribeElasticsearchDomainConfig' { _dedcDomainName :: Text@@ -53,7 +57,7 @@ -- -- Use one of the following lenses to modify other fields as desired: ----- * 'dedcDomainName'+-- * 'dedcDomainName' - The Elasticsearch domain that you want to get information about. describeElasticsearchDomainConfig :: Text -- ^ 'dedcDomainName' -> DescribeElasticsearchDomainConfig@@ -96,8 +100,10 @@ where toQuery = const mempty --- | The result of a 'DescribeElasticsearchDomainConfig' request. Contains the configuration information of the requested domain.+-- | The result of a @DescribeElasticsearchDomainConfig@ request. Contains the configuration information of the requested domain. --+--+-- -- /See:/ 'describeElasticsearchDomainConfigResponse' smart constructor. data DescribeElasticsearchDomainConfigResponse = DescribeElasticsearchDomainConfigResponse' { _dedcrsResponseStatus :: !Int@@ -108,9 +114,9 @@ -- -- Use one of the following lenses to modify other fields as desired: ----- * 'dedcrsResponseStatus'+-- * 'dedcrsResponseStatus' - -- | The response status code. ----- * 'dedcrsDomainConfig'+-- * 'dedcrsDomainConfig' - The configuration information of the domain requested in the @DescribeElasticsearchDomainConfig@ request. describeElasticsearchDomainConfigResponse :: Int -- ^ 'dedcrsResponseStatus' -> ElasticsearchDomainConfig -- ^ 'dedcrsDomainConfig'@@ -121,11 +127,11 @@ , _dedcrsDomainConfig = pDomainConfig_ } --- | The response status code.+-- | -- | The response status code. dedcrsResponseStatus :: Lens' DescribeElasticsearchDomainConfigResponse Int dedcrsResponseStatus = lens _dedcrsResponseStatus (\ s a -> s{_dedcrsResponseStatus = a}); --- | The configuration information of the domain requested in the 'DescribeElasticsearchDomainConfig' request.+-- | The configuration information of the domain requested in the @DescribeElasticsearchDomainConfig@ request. dedcrsDomainConfig :: Lens' DescribeElasticsearchDomainConfigResponse ElasticsearchDomainConfig dedcrsDomainConfig = lens _dedcrsDomainConfig (\ s a -> s{_dedcrsDomainConfig = a});
gen/Network/AWS/ElasticSearch/DescribeElasticsearchDomains.hs view
@@ -19,6 +19,8 @@ -- Portability : non-portable (GHC extensions) -- -- Returns domain configuration information about the specified Elasticsearch domains, including the domain ID, domain endpoint, and domain ARN.+--+-- module Network.AWS.ElasticSearch.DescribeElasticsearchDomains ( -- * Creating a Request@@ -42,8 +44,10 @@ import Network.AWS.Request import Network.AWS.Response --- | Container for the parameters to the 'DescribeElasticsearchDomains' operation. By default, the API returns the status of all Elasticsearch domains.+-- | Container for the parameters to the @'DescribeElasticsearchDomains' @ operation. By default, the API returns the status of all Elasticsearch domains. --+--+-- -- /See:/ 'describeElasticsearchDomains' smart constructor. newtype DescribeElasticsearchDomains = DescribeElasticsearchDomains' { _dedDomainNames :: [Text]@@ -53,7 +57,7 @@ -- -- Use one of the following lenses to modify other fields as desired: ----- * 'dedDomainNames'+-- * 'dedDomainNames' - The Elasticsearch domains for which you want information. describeElasticsearchDomains :: DescribeElasticsearchDomains describeElasticsearchDomains =@@ -95,8 +99,10 @@ instance ToQuery DescribeElasticsearchDomains where toQuery = const mempty --- | The result of a 'DescribeElasticsearchDomains' request. Contains the status of the specified domains or all domains owned by the account.+-- | The result of a @DescribeElasticsearchDomains@ request. Contains the status of the specified domains or all domains owned by the account. --+--+-- -- /See:/ 'describeElasticsearchDomainsResponse' smart constructor. data DescribeElasticsearchDomainsResponse = DescribeElasticsearchDomainsResponse' { _drsResponseStatus :: !Int@@ -107,9 +113,9 @@ -- -- Use one of the following lenses to modify other fields as desired: ----- * 'drsResponseStatus'+-- * 'drsResponseStatus' - -- | The response status code. ----- * 'drsDomainStatusList'+-- * 'drsDomainStatusList' - The status of the domains requested in the @DescribeElasticsearchDomains@ request. describeElasticsearchDomainsResponse :: Int -- ^ 'drsResponseStatus' -> DescribeElasticsearchDomainsResponse@@ -119,11 +125,11 @@ , _drsDomainStatusList = mempty } --- | The response status code.+-- | -- | The response status code. drsResponseStatus :: Lens' DescribeElasticsearchDomainsResponse Int drsResponseStatus = lens _drsResponseStatus (\ s a -> s{_drsResponseStatus = a}); --- | The status of the domains requested in the 'DescribeElasticsearchDomains' request.+-- | The status of the domains requested in the @DescribeElasticsearchDomains@ request. drsDomainStatusList :: Lens' DescribeElasticsearchDomainsResponse [ElasticsearchDomainStatus] drsDomainStatusList = lens _drsDomainStatusList (\ s a -> s{_drsDomainStatusList = a}) . _Coerce;
gen/Network/AWS/ElasticSearch/ListDomainNames.hs view
@@ -18,7 +18,9 @@ -- Stability : auto-generated -- Portability : non-portable (GHC extensions) ----- Returns the name of all Elasticsearch domains owned by the current user\'s account.+-- Returns the name of all Elasticsearch domains owned by the current user's account.+--+-- module Network.AWS.ElasticSearch.ListDomainNames ( -- * Creating a Request@@ -74,8 +76,10 @@ instance ToQuery ListDomainNames where toQuery = const mempty --- | The result of a 'ListDomainNames' operation. Contains the names of all Elasticsearch domains owned by this account.+-- | The result of a @ListDomainNames@ operation. Contains the names of all Elasticsearch domains owned by this account. --+--+-- -- /See:/ 'listDomainNamesResponse' smart constructor. data ListDomainNamesResponse = ListDomainNamesResponse' { _ldnrsDomainNames :: !(Maybe [DomainInfo])@@ -86,9 +90,9 @@ -- -- Use one of the following lenses to modify other fields as desired: ----- * 'ldnrsDomainNames'+-- * 'ldnrsDomainNames' - List of Elasticsearch domain names. ----- * 'ldnrsResponseStatus'+-- * 'ldnrsResponseStatus' - -- | The response status code. listDomainNamesResponse :: Int -- ^ 'ldnrsResponseStatus' -> ListDomainNamesResponse@@ -102,7 +106,7 @@ ldnrsDomainNames :: Lens' ListDomainNamesResponse [DomainInfo] ldnrsDomainNames = lens _ldnrsDomainNames (\ s a -> s{_ldnrsDomainNames = a}) . _Default . _Coerce; --- | The response status code.+-- | -- | The response status code. ldnrsResponseStatus :: Lens' ListDomainNamesResponse Int ldnrsResponseStatus = lens _ldnrsResponseStatus (\ s a -> s{_ldnrsResponseStatus = a});
gen/Network/AWS/ElasticSearch/ListTags.hs view
@@ -19,6 +19,8 @@ -- Portability : non-portable (GHC extensions) -- -- Returns all tags for the given Elasticsearch domain.+--+-- module Network.AWS.ElasticSearch.ListTags ( -- * Creating a Request@@ -42,8 +44,10 @@ import Network.AWS.Request import Network.AWS.Response --- | Container for the parameters to the 'ListTags' operation. Specify the 'ARN' for the Elasticsearch domain to which the tags are attached that you want to view are attached.+-- | Container for the parameters to the @'ListTags' @ operation. Specify the @ARN@ for the Elasticsearch domain to which the tags are attached that you want to view are attached. --+--+-- -- /See:/ 'listTags' smart constructor. newtype ListTags = ListTags' { _ltARN :: Text@@ -53,7 +57,7 @@ -- -- Use one of the following lenses to modify other fields as desired: ----- * 'ltARN'+-- * 'ltARN' - Specify the @ARN@ for the Elasticsearch domain to which the tags are attached that you want to view. listTags :: Text -- ^ 'ltARN' -> ListTags@@ -62,7 +66,7 @@ { _ltARN = pARN_ } --- | Specify the 'ARN' for the Elasticsearch domain to which the tags are attached that you want to view.+-- | Specify the @ARN@ for the Elasticsearch domain to which the tags are attached that you want to view. ltARN :: Lens' ListTags Text ltARN = lens _ltARN (\ s a -> s{_ltARN = a}); @@ -88,8 +92,10 @@ instance ToQuery ListTags where toQuery ListTags'{..} = mconcat ["arn" =: _ltARN] --- | The result of a 'ListTags' operation. Contains tags for all requested Elasticsearch domains.+-- | The result of a @ListTags@ operation. Contains tags for all requested Elasticsearch domains. --+--+-- -- /See:/ 'listTagsResponse' smart constructor. data ListTagsResponse = ListTagsResponse' { _ltrsTagList :: !(Maybe [Tag])@@ -100,9 +106,9 @@ -- -- Use one of the following lenses to modify other fields as desired: ----- * 'ltrsTagList'+-- * 'ltrsTagList' - List of @Tag@ for the requested Elasticsearch domain. ----- * 'ltrsResponseStatus'+-- * 'ltrsResponseStatus' - -- | The response status code. listTagsResponse :: Int -- ^ 'ltrsResponseStatus' -> ListTagsResponse@@ -112,11 +118,11 @@ , _ltrsResponseStatus = pResponseStatus_ } --- | List of 'Tag' for the requested Elasticsearch domain.+-- | List of @Tag@ for the requested Elasticsearch domain. ltrsTagList :: Lens' ListTagsResponse [Tag] ltrsTagList = lens _ltrsTagList (\ s a -> s{_ltrsTagList = a}) . _Default . _Coerce; --- | The response status code.+-- | -- | The response status code. ltrsResponseStatus :: Lens' ListTagsResponse Int ltrsResponseStatus = lens _ltrsResponseStatus (\ s a -> s{_ltrsResponseStatus = a});
gen/Network/AWS/ElasticSearch/RemoveTags.hs view
@@ -19,6 +19,8 @@ -- Portability : non-portable (GHC extensions) -- -- Removes the specified set of tags from the specified Elasticsearch domain.+--+-- module Network.AWS.ElasticSearch.RemoveTags ( -- * Creating a Request@@ -40,8 +42,10 @@ import Network.AWS.Request import Network.AWS.Response --- | Container for the parameters to the 'RemoveTags' operation. Specify the 'ARN' for the Elasticsearch domain from which you want to remove the specified 'TagKey'.+-- | Container for the parameters to the @'RemoveTags' @ operation. Specify the @ARN@ for the Elasticsearch domain from which you want to remove the specified @TagKey@ . --+--+-- -- /See:/ 'removeTags' smart constructor. data RemoveTags = RemoveTags' { _rtARN :: !Text@@ -52,9 +56,9 @@ -- -- Use one of the following lenses to modify other fields as desired: ----- * 'rtARN'+-- * 'rtARN' - Specifies the @ARN@ for the Elasticsearch domain from which you want to delete the specified tags. ----- * 'rtTagKeys'+-- * 'rtTagKeys' - Specifies the @TagKey@ list which you want to remove from the Elasticsearch domain. removeTags :: Text -- ^ 'rtARN' -> RemoveTags@@ -64,11 +68,11 @@ , _rtTagKeys = mempty } --- | Specifies the 'ARN' for the Elasticsearch domain from which you want to delete the specified tags.+-- | Specifies the @ARN@ for the Elasticsearch domain from which you want to delete the specified tags. rtARN :: Lens' RemoveTags Text rtARN = lens _rtARN (\ s a -> s{_rtARN = a}); --- | Specifies the 'TagKey' list which you want to remove from the Elasticsearch domain.+-- | Specifies the @TagKey@ list which you want to remove from the Elasticsearch domain. rtTagKeys :: Lens' RemoveTags [Text] rtTagKeys = lens _rtTagKeys (\ s a -> s{_rtTagKeys = a}) . _Coerce;
gen/Network/AWS/ElasticSearch/Types.hs view
@@ -147,7 +147,7 @@ import Network.AWS.Prelude import Network.AWS.Sign.V4 --- | API version '2015-01-01' of the Amazon Elasticsearch Service SDK configuration.+-- | API version @2015-01-01@ of the Amazon Elasticsearch Service SDK configuration. elasticSearch :: Service elasticSearch = Service@@ -181,41 +181,57 @@ | has (hasStatus 509) e = Just "limit_exceeded" | otherwise = Nothing --- | An exception for missing \/ invalid input fields. Gives http status code of 400.+-- | An exception for missing / invalid input fields. Gives http status code of 400.+--+-- _ValidationException :: AsError a => Getting (First ServiceError) a ServiceError _ValidationException = _ServiceError . hasStatus 400 . hasCode "ValidationException" -- | An exception for creating a resource that already exists. Gives http status code of 400.+--+-- _ResourceAlreadyExistsException :: AsError a => Getting (First ServiceError) a ServiceError _ResourceAlreadyExistsException = _ServiceError . hasStatus 409 . hasCode "ResourceAlreadyExistsException" -- | An error occurred while processing the request.+--+-- _BaseException :: AsError a => Getting (First ServiceError) a ServiceError _BaseException = _ServiceError . hasCode "BaseException" -- | An error occured because the client wanted to access a not supported operation. Gives http status code of 409.+--+-- _DisabledOperationException :: AsError a => Getting (First ServiceError) a ServiceError _DisabledOperationException = _ServiceError . hasStatus 409 . hasCode "DisabledOperationException" -- | The request processing has failed because of an unknown error, exception or failure (the failure is internal to the service) . Gives http status code of 500.+--+-- _InternalException :: AsError a => Getting (First ServiceError) a ServiceError _InternalException = _ServiceError . hasStatus 500 . hasCode "InternalException" -- | An exception for trying to create or access sub-resource that is either invalid or not supported. Gives http status code of 409.+--+-- _InvalidTypeException :: AsError a => Getting (First ServiceError) a ServiceError _InvalidTypeException = _ServiceError . hasStatus 409 . hasCode "InvalidTypeException" -- | An exception for accessing or deleting a resource that does not exist. Gives http status code of 400.+--+-- _ResourceNotFoundException :: AsError a => Getting (First ServiceError) a ServiceError _ResourceNotFoundException = _ServiceError . hasStatus 409 . hasCode "ResourceNotFoundException" -- | An exception for trying to create more than allowed resources or sub-resources. Gives http status code of 409.+--+-- _LimitExceededException :: AsError a => Getting (First ServiceError) a ServiceError _LimitExceededException = _ServiceError . hasStatus 409 . hasCode "LimitExceededException"
gen/Network/AWS/ElasticSearch/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' - The access policy configured for the Elasticsearch domain. Access policies may be resource-based, IP-based, or IAM-based. See <http://docs.aws.amazon.com/elasticsearch-service/latest/developerguide/es-createupdatedomains.html#es-createdomain-configure-access-policies Configuring Access Policies> for more information. ----- * 'apsStatus'+-- * 'apsStatus' - The status of the access policy for the Elasticsearch domain. See @OptionStatus@ for the status information that's included. accessPoliciesStatus :: Text -- ^ 'apsOptions' -> OptionStatus -- ^ 'apsStatus'@@ -46,11 +48,11 @@ , _apsStatus = pStatus_ } --- | The access policy configured for the Elasticsearch domain. Access policies may be resource-based, IP-based, or IAM-based. See <http://docs.aws.amazon.com/elasticsearch-service/latest/developerguide/es-createupdatedomains.html#es-createdomain-configure-access-policies Configuring Access Policies>for more information.+-- | The access policy configured for the Elasticsearch domain. Access policies may be resource-based, IP-based, or IAM-based. See <http://docs.aws.amazon.com/elasticsearch-service/latest/developerguide/es-createupdatedomains.html#es-createdomain-configure-access-policies Configuring Access Policies> for more information. apsOptions :: Lens' AccessPoliciesStatus Text apsOptions = lens _apsOptions (\ s a -> s{_apsOptions = a}); --- | The status of the access policy for the Elasticsearch domain. See 'OptionStatus' for the status information that\'s included.+-- | The status of the access policy for the Elasticsearch domain. See @OptionStatus@ for the status information that's included. apsStatus :: Lens' AccessPoliciesStatus OptionStatus apsStatus = lens _apsStatus (\ s a -> s{_apsStatus = a}); @@ -67,11 +69,12 @@ -- | Status of the advanced options for the specified Elasticsearch domain. Currently, the following advanced options are available: ----- - Option to allow references to indices in an HTTP request body. Must be 'false' when configuring access to individual sub-resources. By default, the value is 'true'. See <http://docs.aws.amazon.com/elasticsearch-service/latest/developerguide/es-createupdatedomains.html#es-createdomain-configure-advanced-options Configuration Advanced Options> for more information.--- - Option to specify the percentage of heap space that is allocated to field data. By default, this setting is unbounded. ----- For more information, see <http://docs.aws.amazon.com/elasticsearch-service/latest/developerguide/es-createupdatedomains.html#es-createdomain-configure-advanced-options Configuring Advanced Options>.+-- * Option to allow references to indices in an HTTP request body. Must be @false@ when configuring access to individual sub-resources. By default, the value is @true@ . See <http://docs.aws.amazon.com/elasticsearch-service/latest/developerguide/es-createupdatedomains.html#es-createdomain-configure-advanced-options Configuration Advanced Options> for more information. * Option to specify the percentage of heap space that is allocated to field data. By default, this setting is unbounded. --+-- For more information, see <http://docs.aws.amazon.com/elasticsearch-service/latest/developerguide/es-createupdatedomains.html#es-createdomain-configure-advanced-options Configuring Advanced Options> .+--+-- -- /See:/ 'advancedOptionsStatus' smart constructor. data AdvancedOptionsStatus = AdvancedOptionsStatus' { _aosOptions :: !(Map Text Text)@@ -82,9 +85,9 @@ -- -- Use one of the following lenses to modify other fields as desired: ----- * 'aosOptions'+-- * 'aosOptions' - Specifies the status of advanced options for the specified Elasticsearch domain. ----- * 'aosStatus'+-- * 'aosStatus' - Specifies the status of @OptionStatus@ for advanced options for the specified Elasticsearch domain. advancedOptionsStatus :: OptionStatus -- ^ 'aosStatus' -> AdvancedOptionsStatus@@ -98,7 +101,7 @@ aosOptions :: Lens' AdvancedOptionsStatus (HashMap Text Text) aosOptions = lens _aosOptions (\ s a -> s{_aosOptions = a}) . _Map; --- | Specifies the status of 'OptionStatus' for advanced options for the specified Elasticsearch domain.+-- | Specifies the status of @OptionStatus@ for advanced options for the specified Elasticsearch domain. aosStatus :: Lens' AdvancedOptionsStatus OptionStatus aosStatus = lens _aosStatus (\ s a -> s{_aosStatus = a}); @@ -122,7 +125,7 @@ -- -- Use one of the following lenses to modify other fields as desired: ----- * 'diDomainName'+-- * 'diDomainName' - Specifies the @DomainName@ . domainInfo :: DomainInfo domainInfo =@@ -130,7 +133,7 @@ { _diDomainName = Nothing } --- | Specifies the 'DomainName'.+-- | Specifies the @DomainName@ . diDomainName :: Lens' DomainInfo (Maybe Text) diDomainName = lens _diDomainName (\ s a -> s{_diDomainName = a}); @@ -143,8 +146,10 @@ instance NFData DomainInfo --- | Options to enable, disable, and specify the properties of EBS storage volumes. For more information, see <http://docs.aws.amazon.com/elasticsearch-service/latest/developerguide/es-createupdatedomains.html#es-createdomain-configure-ebs Configuring EBS-based Storage>.+-- | Options to enable, disable, and specify the properties of EBS storage volumes. For more information, see <http://docs.aws.amazon.com/elasticsearch-service/latest/developerguide/es-createupdatedomains.html#es-createdomain-configure-ebs Configuring EBS-based Storage> . --+--+-- -- /See:/ 'ebsOptions' smart constructor. data EBSOptions = EBSOptions' { _eoVolumeSize :: !(Maybe Int)@@ -157,13 +162,13 @@ -- -- Use one of the following lenses to modify other fields as desired: ----- * 'eoVolumeSize'+-- * 'eoVolumeSize' - Integer to specify the size of an EBS volume. ----- * 'eoIOPS'+-- * 'eoIOPS' - Specifies the IOPD for a Provisioned IOPS EBS volume (SSD). ----- * 'eoVolumeType'+-- * 'eoVolumeType' - Specifies the volume type for EBS-based storage. ----- * 'eoEBSEnabled'+-- * 'eoEBSEnabled' - Specifies whether EBS-based storage is enabled. ebsOptions :: EBSOptions ebsOptions =@@ -214,6 +219,8 @@ -- | Status of the EBS options for the specified Elasticsearch domain. --+--+-- -- /See:/ 'ebsOptionsStatus' smart constructor. data EBSOptionsStatus = EBSOptionsStatus' { _eosOptions :: !EBSOptions@@ -224,9 +231,9 @@ -- -- Use one of the following lenses to modify other fields as desired: ----- * 'eosOptions'+-- * 'eosOptions' - Specifies the EBS options for the specified Elasticsearch domain. ----- * 'eosStatus'+-- * 'eosStatus' - Specifies the status of the EBS options for the specified Elasticsearch domain. ebsOptionsStatus :: EBSOptions -- ^ 'eosOptions' -> OptionStatus -- ^ 'eosStatus'@@ -258,6 +265,8 @@ -- | Specifies the configuration for the domain cluster, such as the type and number of instances. --+--+-- -- /See:/ 'elasticsearchClusterConfig' smart constructor. data ElasticsearchClusterConfig = ElasticsearchClusterConfig' { _eccDedicatedMasterCount :: !(Maybe Int)@@ -272,17 +281,17 @@ -- -- Use one of the following lenses to modify other fields as desired: ----- * 'eccDedicatedMasterCount'+-- * 'eccDedicatedMasterCount' - Total number of dedicated master nodes, active and on standby, for the cluster. ----- * 'eccDedicatedMasterType'+-- * 'eccDedicatedMasterType' - The instance type for a dedicated master node. ----- * 'eccDedicatedMasterEnabled'+-- * 'eccDedicatedMasterEnabled' - A boolean value to indicate whether a dedicated master node is enabled. See <http://docs.aws.amazon.com/elasticsearch-service/latest/developerguide/es-managedomains.html#es-managedomains-dedicatedmasternodes About Dedicated Master Nodes> for more information. ----- * 'eccInstanceCount'+-- * 'eccInstanceCount' - The number of instances in the specified domain cluster. ----- * 'eccZoneAwarenessEnabled'+-- * 'eccZoneAwarenessEnabled' - A boolean value to indicate whether zone awareness is enabled. See <http://docs.aws.amazon.com/elasticsearch-service/latest/developerguide/es-managedomains.html#es-managedomains-zoneawareness About Zone Awareness> for more information. ----- * 'eccInstanceType'+-- * 'eccInstanceType' - The instance type for an Elasticsearch cluster. elasticsearchClusterConfig :: ElasticsearchClusterConfig elasticsearchClusterConfig =@@ -352,6 +361,8 @@ -- | Specifies the configuration status for the specified Elasticsearch domain. --+--+-- -- /See:/ 'elasticsearchClusterConfigStatus' smart constructor. data ElasticsearchClusterConfigStatus = ElasticsearchClusterConfigStatus' { _eccsOptions :: !ElasticsearchClusterConfig@@ -362,9 +373,9 @@ -- -- Use one of the following lenses to modify other fields as desired: ----- * 'eccsOptions'+-- * 'eccsOptions' - Specifies the cluster configuration for the specified Elasticsearch domain. ----- * 'eccsStatus'+-- * 'eccsStatus' - Specifies the status of the configuration for the specified Elasticsearch domain. elasticsearchClusterConfigStatus :: ElasticsearchClusterConfig -- ^ 'eccsOptions' -> OptionStatus -- ^ 'eccsStatus'@@ -397,6 +408,8 @@ -- | The configuration of an Elasticsearch domain. --+--+-- -- /See:/ 'elasticsearchDomainConfig' smart constructor. data ElasticsearchDomainConfig = ElasticsearchDomainConfig' { _edcEBSOptions :: !(Maybe EBSOptionsStatus)@@ -411,17 +424,17 @@ -- -- Use one of the following lenses to modify other fields as desired: ----- * 'edcEBSOptions'+-- * 'edcEBSOptions' - Specifies the @EBSOptions@ for the Elasticsearch domain. ----- * 'edcAccessPolicies'+-- * 'edcAccessPolicies' - IAM access policy as a JSON-formatted string. ----- * 'edcElasticsearchClusterConfig'+-- * 'edcElasticsearchClusterConfig' - Specifies the @ElasticsearchClusterConfig@ for the Elasticsearch domain. ----- * 'edcSnapshotOptions'+-- * 'edcSnapshotOptions' - Specifies the @SnapshotOptions@ for the Elasticsearch domain. ----- * 'edcAdvancedOptions'+-- * 'edcAdvancedOptions' - Specifies the @AdvancedOptions@ for the domain. See <http://docs.aws.amazon.com/elasticsearch-service/latest/developerguide/es-createupdatedomains.html#es-createdomain-configure-advanced-options Configuring Advanced Options> for more information. ----- * 'edcElasticsearchVersion'+-- * 'edcElasticsearchVersion' - String of format X.Y to specify version for the Elasticsearch domain. elasticsearchDomainConfig :: ElasticsearchDomainConfig elasticsearchDomainConfig =@@ -434,7 +447,7 @@ , _edcElasticsearchVersion = Nothing } --- | Specifies the 'EBSOptions' for the Elasticsearch domain.+-- | Specifies the @EBSOptions@ for the Elasticsearch domain. edcEBSOptions :: Lens' ElasticsearchDomainConfig (Maybe EBSOptionsStatus) edcEBSOptions = lens _edcEBSOptions (\ s a -> s{_edcEBSOptions = a}); @@ -442,15 +455,15 @@ edcAccessPolicies :: Lens' ElasticsearchDomainConfig (Maybe AccessPoliciesStatus) edcAccessPolicies = lens _edcAccessPolicies (\ s a -> s{_edcAccessPolicies = a}); --- | Specifies the 'ElasticsearchClusterConfig' for the Elasticsearch domain.+-- | Specifies the @ElasticsearchClusterConfig@ for the Elasticsearch domain. edcElasticsearchClusterConfig :: Lens' ElasticsearchDomainConfig (Maybe ElasticsearchClusterConfigStatus) edcElasticsearchClusterConfig = lens _edcElasticsearchClusterConfig (\ s a -> s{_edcElasticsearchClusterConfig = a}); --- | Specifies the 'SnapshotOptions' for the Elasticsearch domain.+-- | Specifies the @SnapshotOptions@ for the Elasticsearch domain. edcSnapshotOptions :: Lens' ElasticsearchDomainConfig (Maybe SnapshotOptionsStatus) edcSnapshotOptions = lens _edcSnapshotOptions (\ s a -> s{_edcSnapshotOptions = a}); --- | Specifies the 'AdvancedOptions' for the domain. See <http://docs.aws.amazon.com/elasticsearch-service/latest/developerguide/es-createupdatedomains.html#es-createdomain-configure-advanced-options Configuring Advanced Options> for more information.+-- | Specifies the @AdvancedOptions@ for the domain. See <http://docs.aws.amazon.com/elasticsearch-service/latest/developerguide/es-createupdatedomains.html#es-createdomain-configure-advanced-options Configuring Advanced Options> for more information. edcAdvancedOptions :: Lens' ElasticsearchDomainConfig (Maybe AdvancedOptionsStatus) edcAdvancedOptions = lens _edcAdvancedOptions (\ s a -> s{_edcAdvancedOptions = a}); @@ -475,6 +488,8 @@ -- | The current status of an Elasticsearch domain. --+--+-- -- /See:/ 'elasticsearchDomainStatus' smart constructor. data ElasticsearchDomainStatus = ElasticsearchDomainStatus' { _edsEBSOptions :: !(Maybe EBSOptions)@@ -496,31 +511,31 @@ -- -- Use one of the following lenses to modify other fields as desired: ----- * 'edsEBSOptions'+-- * 'edsEBSOptions' - The @EBSOptions@ for the specified domain. See <http://docs.aws.amazon.com/elasticsearch-service/latest/developerguide/es-createupdatedomains.html#es-createdomain-configure-ebs Configuring EBS-based Storage> for more information. ----- * 'edsAccessPolicies'+-- * 'edsAccessPolicies' - IAM access policy as a JSON-formatted string. ----- * 'edsCreated'+-- * 'edsCreated' - The domain creation status. @True@ if the creation of an Elasticsearch domain is complete. @False@ if domain creation is still in progress. ----- * 'edsSnapshotOptions'+-- * 'edsSnapshotOptions' - Specifies the status of the @SnapshotOptions@ ----- * 'edsDeleted'+-- * 'edsDeleted' - The domain deletion status. @True@ if a delete request has been received for the domain but resource cleanup is still in progress. @False@ if the domain has not been deleted. Once domain deletion is complete, the status of the domain is no longer returned. ----- * 'edsProcessing'+-- * 'edsProcessing' - The status of the Elasticsearch domain configuration. @True@ if Amazon Elasticsearch Service is processing configuration changes. @False@ if the configuration is active. ----- * 'edsEndpoint'+-- * 'edsEndpoint' - The Elasticsearch domain endpoint that you use to submit index and search requests. ----- * 'edsAdvancedOptions'+-- * 'edsAdvancedOptions' - Specifies the status of the @AdvancedOptions@ ----- * 'edsElasticsearchVersion'+-- * 'edsElasticsearchVersion' - Undocumented member. ----- * 'edsDomainId'+-- * 'edsDomainId' - The unique identifier for the specified Elasticsearch domain. ----- * 'edsDomainName'+-- * 'edsDomainName' - The name of an Elasticsearch domain. Domain names are unique across the domains owned by an account within an AWS region. Domain names start with a letter or number and can contain the following characters: a-z (lowercase), 0-9, and - (hyphen). ----- * 'edsARN'+-- * 'edsARN' - The Amazon resource name (ARN) of an Elasticsearch domain. See <http://docs.aws.amazon.com/IAM/latest/UserGuide/index.html?Using_Identifiers.html Identifiers for IAM Entities> in /Using AWS Identity and Access Management/ for more information. ----- * 'edsElasticsearchClusterConfig'+-- * 'edsElasticsearchClusterConfig' - The type and number of instances in the domain cluster. elasticsearchDomainStatus :: Text -- ^ 'edsDomainId' -> Text -- ^ 'edsDomainName'@@ -544,7 +559,7 @@ , _edsElasticsearchClusterConfig = pElasticsearchClusterConfig_ } --- | The 'EBSOptions' for the specified domain. See <http://docs.aws.amazon.com/elasticsearch-service/latest/developerguide/es-createupdatedomains.html#es-createdomain-configure-ebs Configuring EBS-based Storage> for more information.+-- | The @EBSOptions@ for the specified domain. See <http://docs.aws.amazon.com/elasticsearch-service/latest/developerguide/es-createupdatedomains.html#es-createdomain-configure-ebs Configuring EBS-based Storage> for more information. edsEBSOptions :: Lens' ElasticsearchDomainStatus (Maybe EBSOptions) edsEBSOptions = lens _edsEBSOptions (\ s a -> s{_edsEBSOptions = a}); @@ -552,19 +567,19 @@ edsAccessPolicies :: Lens' ElasticsearchDomainStatus (Maybe Text) edsAccessPolicies = lens _edsAccessPolicies (\ s a -> s{_edsAccessPolicies = a}); --- | The domain creation status. 'True' if the creation of an Elasticsearch domain is complete. 'False' if domain creation is still in progress.+-- | The domain creation status. @True@ if the creation of an Elasticsearch domain is complete. @False@ if domain creation is still in progress. edsCreated :: Lens' ElasticsearchDomainStatus (Maybe Bool) edsCreated = lens _edsCreated (\ s a -> s{_edsCreated = a}); --- | Specifies the status of the 'SnapshotOptions'+-- | Specifies the status of the @SnapshotOptions@ edsSnapshotOptions :: Lens' ElasticsearchDomainStatus (Maybe SnapshotOptions) edsSnapshotOptions = lens _edsSnapshotOptions (\ s a -> s{_edsSnapshotOptions = a}); --- | The domain deletion status. 'True' if a delete request has been received for the domain but resource cleanup is still in progress. 'False' if the domain has not been deleted. Once domain deletion is complete, the status of the domain is no longer returned.+-- | The domain deletion status. @True@ if a delete request has been received for the domain but resource cleanup is still in progress. @False@ if the domain has not been deleted. Once domain deletion is complete, the status of the domain is no longer returned. edsDeleted :: Lens' ElasticsearchDomainStatus (Maybe Bool) edsDeleted = lens _edsDeleted (\ s a -> s{_edsDeleted = a}); --- | The status of the Elasticsearch domain configuration. 'True' if Amazon Elasticsearch Service is processing configuration changes. 'False' if the configuration is active.+-- | The status of the Elasticsearch domain configuration. @True@ if Amazon Elasticsearch Service is processing configuration changes. @False@ if the configuration is active. edsProcessing :: Lens' ElasticsearchDomainStatus (Maybe Bool) edsProcessing = lens _edsProcessing (\ s a -> s{_edsProcessing = a}); @@ -572,7 +587,7 @@ edsEndpoint :: Lens' ElasticsearchDomainStatus (Maybe Text) edsEndpoint = lens _edsEndpoint (\ s a -> s{_edsEndpoint = a}); --- | Specifies the status of the 'AdvancedOptions'+-- | Specifies the status of the @AdvancedOptions@ edsAdvancedOptions :: Lens' ElasticsearchDomainStatus (HashMap Text Text) edsAdvancedOptions = lens _edsAdvancedOptions (\ s a -> s{_edsAdvancedOptions = a}) . _Default . _Map; @@ -620,6 +635,8 @@ -- | Status of the Elasticsearch version options for the specified Elasticsearch domain. --+--+-- -- /See:/ 'elasticsearchVersionStatus' smart constructor. data ElasticsearchVersionStatus = ElasticsearchVersionStatus' { _evsOptions :: !Text@@ -630,9 +647,9 @@ -- -- Use one of the following lenses to modify other fields as desired: ----- * 'evsOptions'+-- * 'evsOptions' - Specifies the Elasticsearch version for the specified Elasticsearch domain. ----- * 'evsStatus'+-- * 'evsStatus' - Specifies the status of the Elasticsearch version options for the specified Elasticsearch domain. elasticsearchVersionStatus :: Text -- ^ 'evsOptions' -> OptionStatus -- ^ 'evsStatus'@@ -664,6 +681,8 @@ -- | Provides the current status of the entity. --+--+-- -- /See:/ 'optionStatus' smart constructor. data OptionStatus = OptionStatus' { _osPendingDeletion :: !(Maybe Bool)@@ -677,15 +696,15 @@ -- -- Use one of the following lenses to modify other fields as desired: ----- * 'osPendingDeletion'+-- * 'osPendingDeletion' - Indicates whether the Elasticsearch domain is being deleted. ----- * 'osUpdateVersion'+-- * 'osUpdateVersion' - Specifies the latest version for the entity. ----- * 'osCreationDate'+-- * 'osCreationDate' - Timestamp which tells the creation date for the entity. ----- * 'osUpdateDate'+-- * 'osUpdateDate' - Timestamp which tells the last updated time for the entity. ----- * 'osState'+-- * 'osState' - Provides the @OptionState@ for the Elasticsearch domain. optionStatus :: UTCTime -- ^ 'osCreationDate' -> UTCTime -- ^ 'osUpdateDate'@@ -716,7 +735,7 @@ osUpdateDate :: Lens' OptionStatus UTCTime osUpdateDate = lens _osUpdateDate (\ s a -> s{_osUpdateDate = a}) . _Time; --- | Provides the 'OptionState' for the Elasticsearch domain.+-- | Provides the @OptionState@ for the Elasticsearch domain. osState :: Lens' OptionStatus OptionState osState = lens _osState (\ s a -> s{_osState = a}); @@ -734,8 +753,10 @@ instance NFData OptionStatus --- | Specifies the time, in UTC format, when the service takes a daily automated snapshot of the specified Elasticsearch domain. Default value is '0' hours.+-- | Specifies the time, in UTC format, when the service takes a daily automated snapshot of the specified Elasticsearch domain. Default value is @0@ hours. --+--+-- -- /See:/ 'snapshotOptions' smart constructor. newtype SnapshotOptions = SnapshotOptions' { _soAutomatedSnapshotStartHour :: Maybe Int@@ -745,7 +766,7 @@ -- -- Use one of the following lenses to modify other fields as desired: ----- * 'soAutomatedSnapshotStartHour'+-- * 'soAutomatedSnapshotStartHour' - Specifies the time, in UTC format, when the service takes a daily automated snapshot of the specified Elasticsearch domain. Default value is @0@ hours. snapshotOptions :: SnapshotOptions snapshotOptions =@@ -753,7 +774,7 @@ { _soAutomatedSnapshotStartHour = Nothing } --- | Specifies the time, in UTC format, when the service takes a daily automated snapshot of the specified Elasticsearch domain. Default value is '0' hours.+-- | Specifies the time, in UTC format, when the service takes a daily automated snapshot of the specified Elasticsearch domain. Default value is @0@ hours. soAutomatedSnapshotStartHour :: Lens' SnapshotOptions (Maybe Int) soAutomatedSnapshotStartHour = lens _soAutomatedSnapshotStartHour (\ s a -> s{_soAutomatedSnapshotStartHour = a}); @@ -777,6 +798,8 @@ -- | Status of a daily automated snapshot. --+--+-- -- /See:/ 'snapshotOptionsStatus' smart constructor. data SnapshotOptionsStatus = SnapshotOptionsStatus' { _sosOptions :: !SnapshotOptions@@ -787,9 +810,9 @@ -- -- Use one of the following lenses to modify other fields as desired: ----- * 'sosOptions'+-- * 'sosOptions' - Specifies the daily snapshot options specified for the Elasticsearch domain. ----- * 'sosStatus'+-- * 'sosStatus' - Specifies the status of a daily automated snapshot. snapshotOptionsStatus :: SnapshotOptions -- ^ 'sosOptions' -> OptionStatus -- ^ 'sosStatus'@@ -821,6 +844,8 @@ -- | Specifies a key value pair for a resource tag. --+--+-- -- /See:/ 'tag' smart constructor. data Tag = Tag' { _tagKey :: !Text@@ -831,9 +856,9 @@ -- -- Use one of the following lenses to modify other fields as desired: ----- * 'tagKey'+-- * 'tagKey' - Specifies the @TagKey@ , the name of the tag. Tag keys must be unique for the Elasticsearch domain to which they are attached. ----- * 'tagValue'+-- * 'tagValue' - Specifies the @TagValue@ , the value assigned to the corresponding tag key. Tag values can be null and do not have to be unique in a tag set. For example, you can have a key value pair in a tag set of @project : Trinity@ and @cost-center : Trinity@ tag :: Text -- ^ 'tagKey' -> Text -- ^ 'tagValue'@@ -844,11 +869,11 @@ , _tagValue = pValue_ } --- | Specifies the 'TagKey', the name of the tag. Tag keys must be unique for the Elasticsearch domain to which they are attached.+-- | Specifies the @TagKey@ , the name of the tag. Tag keys must be unique for the Elasticsearch domain to which they are attached. tagKey :: Lens' Tag Text tagKey = lens _tagKey (\ s a -> s{_tagKey = a}); --- | Specifies the 'TagValue', the value assigned to the corresponding tag key. Tag values can be null and do not have to be unique in a tag set. For example, you can have a key value pair in a tag set of 'project : Trinity' and 'cost-center : Trinity'+-- | Specifies the @TagValue@ , the value assigned to the corresponding tag key. Tag values can be null and do not have to be unique in a tag set. For example, you can have a key value pair in a tag set of @project : Trinity@ and @cost-center : Trinity@ tagValue :: Lens' Tag Text tagValue = lens _tagValue (\ s a -> s{_tagValue = a});
gen/Network/AWS/ElasticSearch/Types/Sum.hs view
@@ -101,8 +101,9 @@ -- | The state of a requested change. One of the following: ----- - Processing: The request change is still in-process.--- - Active: The request change is processed and deployed to the Elasticsearch domain.+--+-- * Processing: The request change is still in-process. * Active: The request change is processed and deployed to the Elasticsearch domain.+-- data OptionState = Active | Processing@@ -132,7 +133,9 @@ instance FromJSON OptionState where parseJSON = parseJSONText "OptionState" --- | The type of EBS volume, standard, gp2, or io1. See <http://docs.aws.amazon.com/elasticsearch-service/latest/developerguide/es-createupdatedomains.html#es-createdomain-configure-ebs Configuring EBS-based Storage>for more information.+-- | The type of EBS volume, standard, gp2, or io1. See <http://docs.aws.amazon.com/elasticsearch-service/latest/developerguide/es-createupdatedomains.html#es-createdomain-configure-ebs Configuring EBS-based Storage> for more information.+--+-- data VolumeType = GP2 | IO1
gen/Network/AWS/ElasticSearch/UpdateElasticsearchDomainConfig.hs view
@@ -19,6 +19,8 @@ -- Portability : non-portable (GHC extensions) -- -- Modifies the cluster configuration of the specified Elasticsearch domain, setting as setting the instance type and the number of instances.+--+-- module Network.AWS.ElasticSearch.UpdateElasticsearchDomainConfig ( -- * Creating a Request@@ -47,8 +49,10 @@ import Network.AWS.Request import Network.AWS.Response --- | Container for the parameters to the 'UpdateElasticsearchDomain' operation. Specifies the type and number of instances in the domain cluster.+-- | Container for the parameters to the @'UpdateElasticsearchDomain' @ operation. Specifies the type and number of instances in the domain cluster. --+--+-- -- /See:/ 'updateElasticsearchDomainConfig' smart constructor. data UpdateElasticsearchDomainConfig = UpdateElasticsearchDomainConfig' { _uedcEBSOptions :: !(Maybe EBSOptions)@@ -63,17 +67,17 @@ -- -- Use one of the following lenses to modify other fields as desired: ----- * 'uedcEBSOptions'+-- * 'uedcEBSOptions' - Specify the type and size of the EBS volume that you want to use. ----- * 'uedcAccessPolicies'+-- * 'uedcAccessPolicies' - IAM access policy as a JSON-formatted string. ----- * 'uedcElasticsearchClusterConfig'+-- * 'uedcElasticsearchClusterConfig' - The type and number of instances to instantiate for the domain cluster. ----- * 'uedcSnapshotOptions'+-- * 'uedcSnapshotOptions' - Option to set the time, in UTC format, for the daily automated snapshot. Default value is @0@ hours. ----- * 'uedcAdvancedOptions'+-- * 'uedcAdvancedOptions' - Modifies the advanced option to allow references to indices in an HTTP request body. Must be @false@ when configuring access to individual sub-resources. By default, the value is @true@ . See <http://docs.aws.amazon.com/elasticsearch-service/latest/developerguide/es-createupdatedomains.html#es-createdomain-configure-advanced-options Configuration Advanced Options> for more information. ----- * 'uedcDomainName'+-- * 'uedcDomainName' - The name of the Elasticsearch domain that you are updating. updateElasticsearchDomainConfig :: Text -- ^ 'uedcDomainName' -> UpdateElasticsearchDomainConfig@@ -99,11 +103,11 @@ uedcElasticsearchClusterConfig :: Lens' UpdateElasticsearchDomainConfig (Maybe ElasticsearchClusterConfig) uedcElasticsearchClusterConfig = lens _uedcElasticsearchClusterConfig (\ s a -> s{_uedcElasticsearchClusterConfig = a}); --- | Option to set the time, in UTC format, for the daily automated snapshot. Default value is '0' hours.+-- | Option to set the time, in UTC format, for the daily automated snapshot. Default value is @0@ hours. uedcSnapshotOptions :: Lens' UpdateElasticsearchDomainConfig (Maybe SnapshotOptions) uedcSnapshotOptions = lens _uedcSnapshotOptions (\ s a -> s{_uedcSnapshotOptions = a}); --- | Modifies the advanced option to allow references to indices in an HTTP request body. Must be 'false' when configuring access to individual sub-resources. By default, the value is 'true'. See <http://docs.aws.amazon.com/elasticsearch-service/latest/developerguide/es-createupdatedomains.html#es-createdomain-configure-advanced-options Configuration Advanced Options> for more information.+-- | Modifies the advanced option to allow references to indices in an HTTP request body. Must be @false@ when configuring access to individual sub-resources. By default, the value is @true@ . See <http://docs.aws.amazon.com/elasticsearch-service/latest/developerguide/es-createupdatedomains.html#es-createdomain-configure-advanced-options Configuration Advanced Options> for more information. uedcAdvancedOptions :: Lens' UpdateElasticsearchDomainConfig (HashMap Text Text) uedcAdvancedOptions = lens _uedcAdvancedOptions (\ s a -> s{_uedcAdvancedOptions = a}) . _Default . _Map; @@ -151,8 +155,10 @@ where toQuery = const mempty --- | The result of an 'UpdateElasticsearchDomain' request. Contains the status of the Elasticsearch domain being updated.+-- | The result of an @UpdateElasticsearchDomain@ request. Contains the status of the Elasticsearch domain being updated. --+--+-- -- /See:/ 'updateElasticsearchDomainConfigResponse' smart constructor. data UpdateElasticsearchDomainConfigResponse = UpdateElasticsearchDomainConfigResponse' { _uedcrsResponseStatus :: !Int@@ -163,9 +169,9 @@ -- -- Use one of the following lenses to modify other fields as desired: ----- * 'uedcrsResponseStatus'+-- * 'uedcrsResponseStatus' - -- | The response status code. ----- * 'uedcrsDomainConfig'+-- * 'uedcrsDomainConfig' - The status of the updated Elasticsearch domain. updateElasticsearchDomainConfigResponse :: Int -- ^ 'uedcrsResponseStatus' -> ElasticsearchDomainConfig -- ^ 'uedcrsDomainConfig'@@ -176,7 +182,7 @@ , _uedcrsDomainConfig = pDomainConfig_ } --- | The response status code.+-- | -- | The response status code. uedcrsResponseStatus :: Lens' UpdateElasticsearchDomainConfigResponse Int uedcrsResponseStatus = lens _uedcrsResponseStatus (\ s a -> s{_uedcrsResponseStatus = a});