diff --git a/README.md b/README.md --- a/README.md +++ b/README.md @@ -8,7 +8,7 @@ ## Version -`1.3.7` +`1.4.0` ## Description @@ -27,7 +27,7 @@ . Documentation is available via [Hackage](http://hackage.haskell.org/package/amazonka-cloudsearch-domains) -and the [AWS API Reference](http://docs.aws.amazon.com/cloudsearch/latest/developerguide/what-is-cloudsearch.html). +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. diff --git a/amazonka-cloudsearch-domains.cabal b/amazonka-cloudsearch-domains.cabal --- a/amazonka-cloudsearch-domains.cabal +++ b/amazonka-cloudsearch-domains.cabal @@ -1,5 +1,5 @@ name: amazonka-cloudsearch-domains -version: 1.3.7 +version: 1.4.0 synopsis: Amazon CloudSearch Domain SDK. homepage: https://github.com/brendanhay/amazonka bug-reports: https://github.com/brendanhay/amazonka/issues @@ -7,7 +7,7 @@ license-file: LICENSE author: Brendan Hay maintainer: Brendan Hay -copyright: Copyright (c) 2013-2015 Brendan Hay +copyright: Copyright (c) 2013-2016 Brendan Hay category: Network, AWS, Cloud, Distributed Computing build-type: Simple cabal-version: >= 1.10 @@ -37,7 +37,7 @@ such as or . . - See "Network.AWS.CloudSearchDomains" and the + See "Network.AWS.CloudSearchDomains" or to get started. source-repository head @@ -63,7 +63,7 @@ , Network.AWS.CloudSearchDomains.Types.Sum build-depends: - amazonka-core == 1.3.7.* + amazonka-core == 1.4.0.* , base >= 4.7 && < 5 test-suite amazonka-cloudsearch-domains-test @@ -83,9 +83,9 @@ , Test.AWS.CloudSearchDomains.Internal build-depends: - amazonka-core == 1.3.7.* - , amazonka-test == 1.3.7.* - , amazonka-cloudsearch-domains == 1.3.7.* + amazonka-core == 1.4.0.* + , amazonka-test == 1.4.0.* + , amazonka-cloudsearch-domains == 1.4.0.* , base , bytestring , tasty diff --git a/gen/Network/AWS/CloudSearchDomains.hs b/gen/Network/AWS/CloudSearchDomains.hs --- a/gen/Network/AWS/CloudSearchDomains.hs +++ b/gen/Network/AWS/CloudSearchDomains.hs @@ -5,7 +5,7 @@ -- | -- Module : Network.AWS.CloudSearchDomains --- Copyright : (c) 2013-2015 Brendan Hay +-- Copyright : (c) 2013-2016 Brendan Hay -- License : Mozilla Public License, v. 2.0. -- Maintainer : Brendan Hay -- Stability : auto-generated @@ -23,8 +23,6 @@ -- -- For more information, see the -- . --- --- /See:/ module Network.AWS.CloudSearchDomains ( -- * Service Configuration @@ -77,6 +75,18 @@ , DocumentServiceWarning , documentServiceWarning , dswMessage + + -- ** FieldStats + , FieldStats + , fieldStats + , fsMax + , fsMean + , fsCount + , fsMissing + , fsStddev + , fsMin + , fsSumOfSquares + , fsSum -- ** Hit , Hit diff --git a/gen/Network/AWS/CloudSearchDomains/Search.hs b/gen/Network/AWS/CloudSearchDomains/Search.hs --- a/gen/Network/AWS/CloudSearchDomains/Search.hs +++ b/gen/Network/AWS/CloudSearchDomains/Search.hs @@ -12,7 +12,7 @@ -- | -- Module : Network.AWS.CloudSearchDomains.Search --- Copyright : (c) 2013-2015 Brendan Hay +-- Copyright : (c) 2013-2016 Brendan Hay -- License : Mozilla Public License, v. 2.0. -- Maintainer : Brendan Hay -- Stability : auto-generated @@ -43,8 +43,6 @@ -- endpoint for your domain, use the Amazon CloudSearch configuration -- service 'DescribeDomains' action. A domain\'s endpoints are also -- displayed on the domain dashboard in the Amazon CloudSearch console. --- --- /See:/ for Search. module Network.AWS.CloudSearchDomains.Search ( -- * Creating a Request @@ -60,6 +58,7 @@ , seaQueryParser , seaStart , seaHighlight + , seaStats , seaSort , seaFacet , seaPartial @@ -71,6 +70,7 @@ -- * Response Lenses , searsStatus , searsFacets + , searsStats , searsHits , searsResponseStatus ) where @@ -95,6 +95,7 @@ , _seaQueryParser :: !(Maybe QueryParser) , _seaStart :: !(Maybe Integer) , _seaHighlight :: !(Maybe Text) + , _seaStats :: !(Maybe Text) , _seaSort :: !(Maybe Text) , _seaFacet :: !(Maybe Text) , _seaPartial :: !(Maybe Bool) @@ -123,6 +124,8 @@ -- -- * 'seaHighlight' -- +-- * 'seaStats' +-- -- * 'seaSort' -- -- * 'seaFacet' @@ -144,6 +147,7 @@ , _seaQueryParser = Nothing , _seaStart = Nothing , _seaHighlight = Nothing + , _seaStats = Nothing , _seaSort = Nothing , _seaFacet = Nothing , _seaPartial = Nothing @@ -384,6 +388,16 @@ seaHighlight :: Lens' Search (Maybe Text) seaHighlight = lens _seaHighlight (\ s a -> s{_seaHighlight = a}); +-- | Specifies one or more fields for which to get statistics information. +-- Each specified field must be facet-enabled in the domain configuration. +-- The fields are specified in JSON using the form: +-- +-- '{\"FIELD-A\":{},\"FIELD-B\":{}}' +-- +-- There are currently no options supported for statistics. +seaStats :: Lens' Search (Maybe Text) +seaStats = lens _seaStats (\ s a -> s{_seaStats = a}); + -- | Specifies the fields or custom expressions to use to sort the search -- results. Multiple fields or expressions are specified as a -- comma-separated list. You must specify the sort direction ('asc' or @@ -494,9 +508,12 @@ (\ s h x -> SearchResponse' <$> (x .?> "status") <*> (x .?> "facets" .!@ mempty) <*> - (x .?> "hits") + (x .?> "stats" .!@ mempty) + <*> (x .?> "hits") <*> (pure (fromEnum s))) +instance Hashable Search + instance ToHeaders Search where toHeaders = const @@ -515,9 +532,10 @@ "q.options" =: _seaQueryOptions, "fq" =: _seaFilterQuery, "size" =: _seaSize, "q.parser" =: _seaQueryParser, "start" =: _seaStart, - "highlight" =: _seaHighlight, "sort" =: _seaSort, - "facet" =: _seaFacet, "partial" =: _seaPartial, - "q" =: _seaQuery, "format=sdk&pretty=true"] + "highlight" =: _seaHighlight, "stats" =: _seaStats, + "sort" =: _seaSort, "facet" =: _seaFacet, + "partial" =: _seaPartial, "q" =: _seaQuery, + "format=sdk&pretty=true"] -- | The result of a 'Search' request. Contains the documents that match the -- specified search criteria and any requested fields, highlights, and @@ -527,6 +545,7 @@ data SearchResponse = SearchResponse' { _searsStatus :: !(Maybe SearchStatus) , _searsFacets :: !(Maybe (Map Text BucketInfo)) + , _searsStats :: !(Maybe (Map Text FieldStats)) , _searsHits :: !(Maybe Hits) , _searsResponseStatus :: !Int } deriving (Eq,Read,Show,Data,Typeable,Generic) @@ -539,6 +558,8 @@ -- -- * 'searsFacets' -- +-- * 'searsStats' +-- -- * 'searsHits' -- -- * 'searsResponseStatus' @@ -549,6 +570,7 @@ SearchResponse' { _searsStatus = Nothing , _searsFacets = Nothing + , _searsStats = Nothing , _searsHits = Nothing , _searsResponseStatus = pResponseStatus_ } @@ -560,6 +582,10 @@ -- | The requested facet information. searsFacets :: Lens' SearchResponse (HashMap Text BucketInfo) searsFacets = lens _searsFacets (\ s a -> s{_searsFacets = a}) . _Default . _Map; + +-- | The requested field statistics information. +searsStats :: Lens' SearchResponse (HashMap Text FieldStats) +searsStats = lens _searsStats (\ s a -> s{_searsStats = a}) . _Default . _Map; -- | The documents that match the search criteria. searsHits :: Lens' SearchResponse (Maybe Hits) diff --git a/gen/Network/AWS/CloudSearchDomains/Suggest.hs b/gen/Network/AWS/CloudSearchDomains/Suggest.hs --- a/gen/Network/AWS/CloudSearchDomains/Suggest.hs +++ b/gen/Network/AWS/CloudSearchDomains/Suggest.hs @@ -12,7 +12,7 @@ -- | -- Module : Network.AWS.CloudSearchDomains.Suggest --- Copyright : (c) 2013-2015 Brendan Hay +-- Copyright : (c) 2013-2016 Brendan Hay -- License : Mozilla Public License, v. 2.0. -- Maintainer : Brendan Hay -- Stability : auto-generated @@ -37,8 +37,6 @@ -- configuration service 'DescribeDomains' action. A domain\'s endpoints -- are also displayed on the domain dashboard in the Amazon CloudSearch -- console. --- --- /See:/ for Suggest. module Network.AWS.CloudSearchDomains.Suggest ( -- * Creating a Request @@ -115,6 +113,8 @@ SuggestResponse' <$> (x .?> "suggest") <*> (x .?> "status") <*> (pure (fromEnum s))) + +instance Hashable Suggest instance ToHeaders Suggest where toHeaders diff --git a/gen/Network/AWS/CloudSearchDomains/Types.hs b/gen/Network/AWS/CloudSearchDomains/Types.hs --- a/gen/Network/AWS/CloudSearchDomains/Types.hs +++ b/gen/Network/AWS/CloudSearchDomains/Types.hs @@ -4,7 +4,7 @@ -- | -- Module : Network.AWS.CloudSearchDomains.Types --- Copyright : (c) 2013-2015 Brendan Hay +-- Copyright : (c) 2013-2016 Brendan Hay -- License : Mozilla Public License, v. 2.0. -- Maintainer : Brendan Hay -- Stability : auto-generated @@ -41,6 +41,18 @@ , documentServiceWarning , dswMessage + -- * FieldStats + , FieldStats + , fieldStats + , fsMax + , fsMean + , fsCount + , fsMissing + , fsStddev + , fsMin + , fsSumOfSquares + , fsSum + -- * Hit , Hit , hit @@ -113,6 +125,7 @@ , _retryCheck = check } check e + | has (hasStatus 429) e = Just "too_many_requests" | has (hasCode "ThrottlingException" . hasStatus 400) e = Just "throttling_exception" | has (hasCode "Throttling" . hasStatus 400) e = Just "throttling" diff --git a/gen/Network/AWS/CloudSearchDomains/Types/Product.hs b/gen/Network/AWS/CloudSearchDomains/Types/Product.hs --- a/gen/Network/AWS/CloudSearchDomains/Types/Product.hs +++ b/gen/Network/AWS/CloudSearchDomains/Types/Product.hs @@ -9,7 +9,7 @@ -- | -- Module : Network.AWS.CloudSearchDomains.Types.Product --- Copyright : (c) 2013-2015 Brendan Hay +-- Copyright : (c) 2013-2016 Brendan Hay -- License : Mozilla Public License, v. 2.0. -- Maintainer : Brendan Hay -- Stability : auto-generated @@ -59,6 +59,8 @@ (\ x -> Bucket' <$> (x .:? "value") <*> (x .:? "count")) +instance Hashable Bucket + -- | A container for the calculated facet values and counts. -- -- /See:/ 'bucketInfo' smart constructor. @@ -87,6 +89,8 @@ = withObject "BucketInfo" (\ x -> BucketInfo' <$> (x .:? "buckets" .!= mempty)) +instance Hashable BucketInfo + -- | A warning returned by the document service when an issue is discovered -- while processing an upload request. -- @@ -117,6 +121,127 @@ (\ x -> DocumentServiceWarning' <$> (x .:? "message")) +instance Hashable DocumentServiceWarning + +-- | The statistics for a field calculated in the request. +-- +-- /See:/ 'fieldStats' smart constructor. +data FieldStats = FieldStats' + { _fsMax :: !(Maybe Text) + , _fsMean :: !(Maybe Text) + , _fsCount :: !(Maybe Integer) + , _fsMissing :: !(Maybe Integer) + , _fsStddev :: !(Maybe Double) + , _fsMin :: !(Maybe Text) + , _fsSumOfSquares :: !(Maybe Double) + , _fsSum :: !(Maybe Double) + } deriving (Eq,Read,Show,Data,Typeable,Generic) + +-- | Creates a value of 'FieldStats' with the minimum fields required to make a request. +-- +-- Use one of the following lenses to modify other fields as desired: +-- +-- * 'fsMax' +-- +-- * 'fsMean' +-- +-- * 'fsCount' +-- +-- * 'fsMissing' +-- +-- * 'fsStddev' +-- +-- * 'fsMin' +-- +-- * 'fsSumOfSquares' +-- +-- * 'fsSum' +fieldStats + :: FieldStats +fieldStats = + FieldStats' + { _fsMax = Nothing + , _fsMean = Nothing + , _fsCount = Nothing + , _fsMissing = Nothing + , _fsStddev = Nothing + , _fsMin = Nothing + , _fsSumOfSquares = Nothing + , _fsSum = Nothing + } + +-- | The maximum value found in the specified field in the result set. +-- +-- If the field is numeric ('int', 'int-array', 'double', or +-- 'double-array'), 'max' is the string representation of a +-- double-precision 64-bit floating point value. If the field is 'date' or +-- 'date-array', 'max' is the string representation of a date with the +-- format specified in : +-- yyyy-mm-ddTHH:mm:ss.SSSZ. +fsMax :: Lens' FieldStats (Maybe Text) +fsMax = lens _fsMax (\ s a -> s{_fsMax = a}); + +-- | The average of the values found in the specified field in the result +-- set. +-- +-- If the field is numeric ('int', 'int-array', 'double', or +-- 'double-array'), 'mean' is the string representation of a +-- double-precision 64-bit floating point value. If the field is 'date' or +-- 'date-array', 'mean' is the string representation of a date with the +-- format specified in : +-- yyyy-mm-ddTHH:mm:ss.SSSZ. +fsMean :: Lens' FieldStats (Maybe Text) +fsMean = lens _fsMean (\ s a -> s{_fsMean = a}); + +-- | The number of documents that contain a value in the specified field in +-- the result set. +fsCount :: Lens' FieldStats (Maybe Integer) +fsCount = lens _fsCount (\ s a -> s{_fsCount = a}); + +-- | The number of documents that do not contain a value in the specified +-- field in the result set. +fsMissing :: Lens' FieldStats (Maybe Integer) +fsMissing = lens _fsMissing (\ s a -> s{_fsMissing = a}); + +-- | The standard deviation of the values in the specified field in the +-- result set. +fsStddev :: Lens' FieldStats (Maybe Double) +fsStddev = lens _fsStddev (\ s a -> s{_fsStddev = a}); + +-- | The minimum value found in the specified field in the result set. +-- +-- If the field is numeric ('int', 'int-array', 'double', or +-- 'double-array'), 'min' is the string representation of a +-- double-precision 64-bit floating point value. If the field is 'date' or +-- 'date-array', 'min' is the string representation of a date with the +-- format specified in : +-- yyyy-mm-ddTHH:mm:ss.SSSZ. +fsMin :: Lens' FieldStats (Maybe Text) +fsMin = lens _fsMin (\ s a -> s{_fsMin = a}); + +-- | The sum of all field values in the result set squared. +fsSumOfSquares :: Lens' FieldStats (Maybe Double) +fsSumOfSquares = lens _fsSumOfSquares (\ s a -> s{_fsSumOfSquares = a}); + +-- | The sum of the field values across the documents in the result set. +-- 'null' for date fields. +fsSum :: Lens' FieldStats (Maybe Double) +fsSum = lens _fsSum (\ s a -> s{_fsSum = a}); + +instance FromJSON FieldStats where + parseJSON + = withObject "FieldStats" + (\ x -> + FieldStats' <$> + (x .:? "max") <*> (x .:? "mean") <*> (x .:? "count") + <*> (x .:? "missing") + <*> (x .:? "stddev") + <*> (x .:? "min") + <*> (x .:? "sumOfSquares") + <*> (x .:? "sum")) + +instance Hashable FieldStats + -- | Information about a document that matches the search request. -- -- /See:/ 'hit' smart constructor. @@ -174,6 +299,8 @@ (x .:? "highlights" .!= mempty) <*> (x .:? "fields" .!= mempty)) +instance Hashable Hit + -- | The collection of documents that match the search request. -- -- /See:/ 'hits' smart constructor. @@ -231,6 +358,8 @@ (x .:? "start") <*> (x .:? "found")) +instance Hashable Hits + -- | Contains the resource id ('rid') and the time it took to process the -- request ('timems'). -- @@ -269,6 +398,8 @@ (\ x -> SearchStatus' <$> (x .:? "rid") <*> (x .:? "timems")) +instance Hashable SearchStatus + -- | Container for the suggestion information returned in a -- 'SuggestResponse'. -- @@ -317,6 +448,8 @@ (x .:? "found") <*> (x .:? "suggestions" .!= mempty) <*> (x .:? "query")) +instance Hashable SuggestModel + -- | Contains the resource id ('rid') and the time it took to process the -- request ('timems'). -- @@ -356,6 +489,8 @@ SuggestStatus' <$> (x .:? "rid") <*> (x .:? "timems")) +instance Hashable SuggestStatus + -- | An autocomplete suggestion that matches the query string specified in a -- 'SuggestRequest'. -- @@ -404,3 +539,5 @@ SuggestionMatch' <$> (x .:? "suggestion") <*> (x .:? "score") <*> (x .:? "id")) + +instance Hashable SuggestionMatch diff --git a/gen/Network/AWS/CloudSearchDomains/Types/Sum.hs b/gen/Network/AWS/CloudSearchDomains/Types/Sum.hs --- a/gen/Network/AWS/CloudSearchDomains/Types/Sum.hs +++ b/gen/Network/AWS/CloudSearchDomains/Types/Sum.hs @@ -9,7 +9,7 @@ -- | -- Module : Network.AWS.CloudSearchDomains.Types.Sum --- Copyright : (c) 2013-2015 Brendan Hay +-- Copyright : (c) 2013-2016 Brendan Hay -- License : Mozilla Public License, v. 2.0. -- Maintainer : Brendan Hay -- Stability : auto-generated diff --git a/gen/Network/AWS/CloudSearchDomains/UploadDocuments.hs b/gen/Network/AWS/CloudSearchDomains/UploadDocuments.hs --- a/gen/Network/AWS/CloudSearchDomains/UploadDocuments.hs +++ b/gen/Network/AWS/CloudSearchDomains/UploadDocuments.hs @@ -12,7 +12,7 @@ -- | -- Module : Network.AWS.CloudSearchDomains.UploadDocuments --- Copyright : (c) 2013-2015 Brendan Hay +-- Copyright : (c) 2013-2016 Brendan Hay -- License : Mozilla Public License, v. 2.0. -- Maintainer : Brendan Hay -- Stability : auto-generated @@ -44,8 +44,6 @@ -- uploading data for indexing, see -- -- in the /Amazon CloudSearch Developer Guide/. --- --- /See:/ for UploadDocuments. module Network.AWS.CloudSearchDomains.UploadDocuments ( -- * Creating a Request diff --git a/gen/Network/AWS/CloudSearchDomains/Waiters.hs b/gen/Network/AWS/CloudSearchDomains/Waiters.hs --- a/gen/Network/AWS/CloudSearchDomains/Waiters.hs +++ b/gen/Network/AWS/CloudSearchDomains/Waiters.hs @@ -7,7 +7,7 @@ -- | -- Module : Network.AWS.CloudSearchDomains.Waiters --- Copyright : (c) 2013-2015 Brendan Hay +-- Copyright : (c) 2013-2016 Brendan Hay -- License : Mozilla Public License, v. 2.0. -- Maintainer : Brendan Hay -- Stability : auto-generated diff --git a/test/Main.hs b/test/Main.hs --- a/test/Main.hs +++ b/test/Main.hs @@ -2,7 +2,7 @@ -- | -- Module : Main --- Copyright : (c) 2013-2015 Brendan Hay +-- Copyright : (c) 2013-2016 Brendan Hay -- License : Mozilla Public License, v. 2.0. -- Maintainer : Brendan Hay -- Stability : auto-generated diff --git a/test/Test/AWS/CloudSearchDomains.hs b/test/Test/AWS/CloudSearchDomains.hs --- a/test/Test/AWS/CloudSearchDomains.hs +++ b/test/Test/AWS/CloudSearchDomains.hs @@ -1,7 +1,7 @@ {-# LANGUAGE OverloadedStrings #-} -- Module : Test.AWS.CloudSearchDomains --- Copyright : (c) 2013-2015 Brendan Hay +-- Copyright : (c) 2013-2016 Brendan Hay -- License : This Source Code Form is subject to the terms of -- the Mozilla Public License, v. 2.0. -- A copy of the MPL can be found in the LICENSE file or diff --git a/test/Test/AWS/CloudSearchDomains/Internal.hs b/test/Test/AWS/CloudSearchDomains/Internal.hs --- a/test/Test/AWS/CloudSearchDomains/Internal.hs +++ b/test/Test/AWS/CloudSearchDomains/Internal.hs @@ -2,7 +2,7 @@ {-# OPTIONS_GHC -fno-warn-unused-imports #-} -- Module : Test.AWS.CloudSearchDomains.Internal --- Copyright : (c) 2013-2015 Brendan Hay +-- Copyright : (c) 2013-2016 Brendan Hay -- License : This Source Code Form is subject to the terms of -- the Mozilla Public License, v. 2.0. -- A copy of the MPL can be found in the LICENSE file or diff --git a/test/Test/AWS/Gen/CloudSearchDomains.hs b/test/Test/AWS/Gen/CloudSearchDomains.hs --- a/test/Test/AWS/Gen/CloudSearchDomains.hs +++ b/test/Test/AWS/Gen/CloudSearchDomains.hs @@ -5,7 +5,7 @@ -- | -- Module : Test.AWS.Gen.CloudSearchDomains --- Copyright : (c) 2013-2015 Brendan Hay +-- Copyright : (c) 2013-2016 Brendan Hay -- License : Mozilla Public License, v. 2.0. -- Maintainer : Brendan Hay -- Stability : auto-generated