summaryrefslogtreecommitdiff
diff options
context:
space:
mode:
authorBrendanHay <>2016-06-10 05:18:00 (GMT)
committerhdiff <hdiff@hdiff.luite.com>2016-06-10 05:18:00 (GMT)
commitb1169180b523ebddd612f6c5fc503262ff387c42 (patch)
treec754abf4bc2d7ddd042e5ebbf98003762c69f360
parent64c89e13842a8483c2a892c9ddb32434066d2536 (diff)
version 1.4.31.4.3
-rw-r--r--README.md35
-rw-r--r--amazonka-cloudsearch-domains.cabal39
-rw-r--r--gen/Network/AWS/CloudSearchDomains.hs13
-rw-r--r--gen/Network/AWS/CloudSearchDomains/Search.hs361
-rw-r--r--gen/Network/AWS/CloudSearchDomains/Suggest.hs23
-rw-r--r--gen/Network/AWS/CloudSearchDomains/Types.hs6
-rw-r--r--gen/Network/AWS/CloudSearchDomains/Types/Product.hs63
-rw-r--r--gen/Network/AWS/CloudSearchDomains/UploadDocuments.hs33
-rw-r--r--test/Test/AWS/Gen/CloudSearchDomains.hs32
9 files changed, 157 insertions, 448 deletions
diff --git a/README.md b/README.md
index 69e082f..2414461 100644
--- a/README.md
+++ b/README.md
@@ -8,23 +8,32 @@
## Version
-`1.4.2`
+`1.4.3`
## Description
-You use the AmazonCloudSearch2013 API to upload documents to a search
-domain and search those documents.
-
-The endpoints for submitting @UploadDocuments@, @Search@, and @Suggest@
-requests are domain-specific. To get the endpoints for your domain, use
-the Amazon CloudSearch configuration service @DescribeDomains@ action.
-The domain endpoints are also displayed on the domain dashboard in the
-Amazon CloudSearch console. You submit suggest requests to the search
-endpoint.
-
-For more information, see the
-<http://docs.aws.amazon.com/cloudsearch/latest/developerguide Amazon CloudSearch Developer Guide>.
+You use the AmazonCloudSearch2013 API to upload documents to a search domain and search those documents.
+
+The endpoints for submitting
+ @
+ UploadDocuments
+ @
+ ,
+ @
+ Search
+ @
+ , and
+ @
+ Suggest
+ @
+ requests are domain-specific. To get the endpoints for your domain, use the Amazon CloudSearch configuration service
+ @
+ DescribeDomains
+ @
+ action. The domain endpoints are also displayed on the domain dashboard in the Amazon CloudSearch console. You submit suggest requests to the search endpoint.
+
+For more information, see the <http://docs.aws.amazon.com/cloudsearch/latest/developerguide Amazon CloudSearch Developer Guide>.
Documentation is available via [Hackage](http://hackage.haskell.org/package/amazonka-cloudsearch-domains)
and the [AWS API Reference](https://aws.amazon.com/documentation/).
diff --git a/amazonka-cloudsearch-domains.cabal b/amazonka-cloudsearch-domains.cabal
index fd52ca2..8d83375 100644
--- a/amazonka-cloudsearch-domains.cabal
+++ b/amazonka-cloudsearch-domains.cabal
@@ -1,5 +1,5 @@
name: amazonka-cloudsearch-domains
-version: 1.4.2
+version: 1.4.3
synopsis: Amazon CloudSearch Domain SDK.
homepage: https://github.com/brendanhay/amazonka
bug-reports: https://github.com/brendanhay/amazonka/issues
@@ -13,18 +13,27 @@ build-type: Simple
cabal-version: >= 1.10
extra-source-files: README.md fixture/*.yaml fixture/*.proto
description:
- You use the AmazonCloudSearch2013 API to upload documents to a search
- domain and search those documents.
+ You use the AmazonCloudSearch2013 API to upload documents to a search domain and search those documents.
- The endpoints for submitting @UploadDocuments@, @Search@, and @Suggest@
- requests are domain-specific. To get the endpoints for your domain, use
- the Amazon CloudSearch configuration service @DescribeDomains@ action.
- The domain endpoints are also displayed on the domain dashboard in the
- Amazon CloudSearch console. You submit suggest requests to the search
- endpoint.
+ The endpoints for submitting
+ @
+ UploadDocuments
+ @
+ ,
+ @
+ Search
+ @
+ , and
+ @
+ Suggest
+ @
+ requests are domain-specific. To get the endpoints for your domain, use the Amazon CloudSearch configuration service
+ @
+ DescribeDomains
+ @
+ action. The domain endpoints are also displayed on the domain dashboard in the Amazon CloudSearch console. You submit suggest requests to the search endpoint.
- For more information, see the
- <http://docs.aws.amazon.com/cloudsearch/latest/developerguide Amazon CloudSearch Developer Guide>.
+ For more information, see the <http://docs.aws.amazon.com/cloudsearch/latest/developerguide Amazon CloudSearch Developer Guide>.
.
The types from this library are intended to be used with
<http://hackage.haskell.org/package/amazonka amazonka>, which provides
@@ -63,7 +72,7 @@ library
, Network.AWS.CloudSearchDomains.Types.Sum
build-depends:
- amazonka-core == 1.4.2.*
+ amazonka-core == 1.4.3.*
, base >= 4.7 && < 5
test-suite amazonka-cloudsearch-domains-test
@@ -83,9 +92,9 @@ test-suite amazonka-cloudsearch-domains-test
, Test.AWS.CloudSearchDomains.Internal
build-depends:
- amazonka-core == 1.4.2.*
- , amazonka-test == 1.4.2.*
- , amazonka-cloudsearch-domains == 1.4.2.*
+ amazonka-core == 1.4.3.*
+ , amazonka-test == 1.4.3.*
+ , amazonka-cloudsearch-domains == 1.4.3.*
, base
, bytestring
, tasty
diff --git a/gen/Network/AWS/CloudSearchDomains.hs b/gen/Network/AWS/CloudSearchDomains.hs
index bb81976..6410d3c 100644
--- a/gen/Network/AWS/CloudSearchDomains.hs
+++ b/gen/Network/AWS/CloudSearchDomains.hs
@@ -11,18 +11,11 @@
-- Stability : auto-generated
-- Portability : non-portable (GHC extensions)
--
--- You use the AmazonCloudSearch2013 API to upload documents to a search
--- domain and search those documents.
+-- You use the AmazonCloudSearch2013 API to upload documents to a search domain and search those documents.
--
--- The endpoints for submitting 'UploadDocuments', 'Search', and 'Suggest'
--- requests are domain-specific. To get the endpoints for your domain, use
--- the Amazon CloudSearch configuration service 'DescribeDomains' action.
--- The domain endpoints are also displayed on the domain dashboard in the
--- Amazon CloudSearch console. You submit suggest requests to the search
--- endpoint.
+-- The endpoints for submitting 'UploadDocuments', 'Search', and 'Suggest' requests are domain-specific. To get the endpoints for your domain, use the Amazon CloudSearch configuration service 'DescribeDomains' action. The domain endpoints are also displayed on the domain dashboard in the Amazon CloudSearch console. You submit suggest requests to the search endpoint.
--
--- For more information, see the
--- <http://docs.aws.amazon.com/cloudsearch/latest/developerguide Amazon CloudSearch Developer Guide>.
+-- For more information, see the <http://docs.aws.amazon.com/cloudsearch/latest/developerguide Amazon CloudSearch Developer Guide>.
module Network.AWS.CloudSearchDomains
(
-- * Service Configuration
diff --git a/gen/Network/AWS/CloudSearchDomains/Search.hs b/gen/Network/AWS/CloudSearchDomains/Search.hs
index 774ef89..754eb5d 100644
--- a/gen/Network/AWS/CloudSearchDomains/Search.hs
+++ b/gen/Network/AWS/CloudSearchDomains/Search.hs
@@ -18,31 +18,16 @@
-- Stability : auto-generated
-- Portability : non-portable (GHC extensions)
--
--- Retrieves a list of documents that match the specified search criteria.
--- How you specify the search criteria depends on which query parser you
--- use. Amazon CloudSearch supports four query parsers:
---
--- - 'simple': search all 'text' and 'text-array' fields for the
--- specified string. Search for phrases, individual terms, and
--- prefixes.
--- - 'structured': search specific fields, construct compound queries
--- using Boolean operators, and use advanced features such as term
--- boosting and proximity searching.
--- - 'lucene': specify search criteria using the Apache Lucene query
--- parser syntax.
--- - 'dismax': specify search criteria using the simplified subset of the
--- Apache Lucene query parser syntax defined by the DisMax query
--- parser.
---
--- For more information, see
--- <http://docs.aws.amazon.com/cloudsearch/latest/developerguide/searching.html Searching Your Data>
--- in the /Amazon CloudSearch Developer Guide/.
---
--- The endpoint for submitting 'Search' requests is domain-specific. You
--- submit search requests to a domain\'s search endpoint. To get the search
--- 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.
+-- Retrieves a list of documents that match the specified search criteria. How you specify the search criteria depends on which query parser you use. Amazon CloudSearch supports four query parsers:
+--
+-- - 'simple': search all 'text' and 'text-array' fields for the specified string. Search for phrases, individual terms, and prefixes.
+-- - 'structured': search specific fields, construct compound queries using Boolean operators, and use advanced features such as term boosting and proximity searching.
+-- - 'lucene': specify search criteria using the Apache Lucene query parser syntax.
+-- - 'dismax': specify search criteria using the simplified subset of the Apache Lucene query parser syntax defined by the DisMax query parser.
+--
+-- For more information, see <http://docs.aws.amazon.com/cloudsearch/latest/developerguide/searching.html Searching Your Data> in the /Amazon CloudSearch Developer Guide/.
+--
+-- The endpoint for submitting 'Search' requests is domain-specific. You submit search requests to a domain\'s search endpoint. To get the search 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.
module Network.AWS.CloudSearchDomains.Search
(
-- * Creating a Request
@@ -154,154 +139,43 @@ search pQuery_ =
, _seaQuery = pQuery_
}
--- | Defines one or more numeric expressions that can be used to sort results
--- or specify search or filter criteria. You can also specify expressions
--- as return fields.
+-- | Defines one or more numeric expressions that can be used to sort results or specify search or filter criteria. You can also specify expressions as return fields.
--
--- You specify the expressions in JSON using the form
--- '{\"EXPRESSIONNAME\":\"EXPRESSION\"}'. You can define and use multiple
--- expressions in a search request. For example:
+-- You specify the expressions in JSON using the form '{\"EXPRESSIONNAME\":\"EXPRESSION\"}'. You can define and use multiple expressions in a search request. For example:
--
-- ' {\"expression1\":\"_score*rating\", \"expression2\":\"(1\/rank)*year\"} '
--
--- For information about the variables, operators, and functions you can
--- use in expressions, see
--- <http://docs.aws.amazon.com/cloudsearch/latest/developerguide/configuring-expressions.html#writing-expressions Writing Expressions>
--- in the /Amazon CloudSearch Developer Guide/.
+-- For information about the variables, operators, and functions you can use in expressions, see <http://docs.aws.amazon.com/cloudsearch/latest/developerguide/configuring-expressions.html#writing-expressions Writing Expressions> in the /Amazon CloudSearch Developer Guide/.
seaExpr :: Lens' Search (Maybe Text)
seaExpr = lens _seaExpr (\ s a -> s{_seaExpr = a});
--- | Retrieves a cursor value you can use to page through large result sets.
--- Use the 'size' parameter to control the number of hits to include in
--- each response. You can specify either the 'cursor' or 'start' parameter
--- in a request; they are mutually exclusive. To get the first cursor, set
--- the cursor value to 'initial'. In subsequent requests, specify the
--- cursor value returned in the hits section of the response.
+-- | Retrieves a cursor value you can use to page through large result sets. Use the 'size' parameter to control the number of hits to include in each response. You can specify either the 'cursor' or 'start' parameter in a request; they are mutually exclusive. To get the first cursor, set the cursor value to 'initial'. In subsequent requests, specify the cursor value returned in the hits section of the response.
--
--- For more information, see
--- <http://docs.aws.amazon.com/cloudsearch/latest/developerguide/paginating-results.html Paginating Results>
--- in the /Amazon CloudSearch Developer Guide/.
+-- For more information, see <http://docs.aws.amazon.com/cloudsearch/latest/developerguide/paginating-results.html Paginating Results> in the /Amazon CloudSearch Developer Guide/.
seaCursor :: Lens' Search (Maybe Text)
seaCursor = lens _seaCursor (\ s a -> s{_seaCursor = a});
--- | Specifies the field and expression values to include in the response.
--- Multiple fields or expressions are specified as a comma-separated list.
--- By default, a search response includes all return enabled fields
--- ('_all_fields'). To return only the document IDs for the matching
--- documents, specify '_no_fields'. To retrieve the relevance score
--- calculated for each document, specify '_score'.
+-- | Specifies the field and expression values to include in the response. Multiple fields or expressions are specified as a comma-separated list. By default, a search response includes all return enabled fields ('_all_fields'). To return only the document IDs for the matching documents, specify '_no_fields'. To retrieve the relevance score calculated for each document, specify '_score'.
seaReturn :: Lens' Search (Maybe Text)
seaReturn = lens _seaReturn (\ s a -> s{_seaReturn = a});
--- | Configures options for the query parser specified in the 'queryParser'
--- parameter. You specify the options in JSON using the following form
--- '{\"OPTION1\":\"VALUE1\",\"OPTION2\":VALUE2\"...\"OPTIONN\":\"VALUEN\"}.'
+-- | Configures options for the query parser specified in the 'queryParser' parameter. You specify the options in JSON using the following form '{\"OPTION1\":\"VALUE1\",\"OPTION2\":VALUE2\"...\"OPTIONN\":\"VALUEN\"}.'
--
-- The options you can configure vary according to which parser you use:
--
--- - 'defaultOperator': The default operator used to combine individual
--- terms in the search string. For example: 'defaultOperator: \'or\''.
--- For the 'dismax' parser, you specify a percentage that represents
--- the percentage of terms in the search string (rounded down) that
--- must match, rather than a default operator. A value of '0%' is the
--- equivalent to OR, and a value of '100%' is equivalent to AND. The
--- percentage must be specified as a value in the range 0-100 followed
--- by the percent (%) symbol. For example, 'defaultOperator: 50%'.
--- Valid values: 'and', 'or', a percentage in the range 0%-100%
--- ('dismax'). Default: 'and' ('simple', 'structured', 'lucene') or
--- '100' ('dismax'). Valid for: 'simple', 'structured', 'lucene', and
--- 'dismax'.
--- - 'fields': An array of the fields to search when no fields are
--- specified in a search. If no fields are specified in a search and
--- this option is not specified, all text and text-array fields are
--- searched. You can specify a weight for each field to control the
--- relative importance of each field when Amazon CloudSearch calculates
--- relevance scores. To specify a field weight, append a caret ('^')
--- symbol and the weight to the field name. For example, to boost the
--- importance of the 'title' field over the 'description' field you
--- could specify: '\"fields\":[\"title^5\",\"description\"]'. Valid
--- values: The name of any configured field and an optional numeric
--- value greater than zero. Default: All 'text' and 'text-array'
--- fields. Valid for: 'simple', 'structured', 'lucene', and 'dismax'.
--- - 'operators': An array of the operators or special characters you
--- want to disable for the simple query parser. If you disable the
--- 'and', 'or', or 'not' operators, the corresponding operators ('+',
--- '|', '-') have no special meaning and are dropped from the search
--- string. Similarly, disabling 'prefix' disables the wildcard operator
--- ('*') and disabling 'phrase' disables the ability to search for
--- phrases by enclosing phrases in double quotes. Disabling precedence
--- disables the ability to control order of precedence using
--- parentheses. Disabling 'near' disables the ability to use the ~
--- operator to perform a sloppy phrase search. Disabling the 'fuzzy'
--- operator disables the ability to use the ~ operator to perform a
--- fuzzy search. 'escape' disables the ability to use a backslash
--- ('\\') to escape special characters within the search string.
--- Disabling whitespace is an advanced option that prevents the parser
--- from tokenizing on whitespace, which can be useful for Vietnamese.
--- (It prevents Vietnamese words from being split incorrectly.) For
--- example, you could disable all operators other than the phrase
--- operator to support just simple term and phrase queries:
--- '\"operators\":[\"and\",\"not\",\"or\", \"prefix\"]'. Valid values:
--- 'and', 'escape', 'fuzzy', 'near', 'not', 'or', 'phrase',
--- 'precedence', 'prefix', 'whitespace'. Default: All operators and
--- special characters are enabled. Valid for: 'simple'.
--- - 'phraseFields': An array of the 'text' or 'text-array' fields you
--- want to use for phrase searches. When the terms in the search string
--- appear in close proximity within a field, the field scores higher.
--- You can specify a weight for each field to boost that score. The
--- 'phraseSlop' option controls how much the matches can deviate from
--- the search string and still be boosted. To specify a field weight,
--- append a caret ('^') symbol and the weight to the field name. For
--- example, to boost phrase matches in the 'title' field over the
--- 'abstract' field, you could specify:
--- '\"phraseFields\":[\"title^3\", \"plot\"]' Valid values: The name of
--- any 'text' or 'text-array' field and an optional numeric value
--- greater than zero. Default: No fields. If you don\'t specify any
--- fields with 'phraseFields', proximity scoring is disabled even if
--- 'phraseSlop' is specified. Valid for: 'dismax'.
--- - 'phraseSlop': An integer value that specifies how much matches can
--- deviate from the search phrase and still be boosted according to the
--- weights specified in the 'phraseFields' option; for example,
--- 'phraseSlop: 2'. You must also specify 'phraseFields' to enable
--- proximity scoring. Valid values: positive integers. Default: 0.
--- Valid for: 'dismax'.
--- - 'explicitPhraseSlop': An integer value that specifies how much a
--- match can deviate from the search phrase when the phrase is enclosed
--- in double quotes in the search string. (Phrases that exceed this
--- proximity distance are not considered a match.) For example, to
--- specify a slop of three for dismax phrase queries, you would specify
--- '\"explicitPhraseSlop\":3'. Valid values: positive integers.
--- Default: 0. Valid for: 'dismax'.
--- - 'tieBreaker': When a term in the search string is found in a
--- document\'s field, a score is calculated for that field based on how
--- common the word is in that field compared to other documents. If the
--- term occurs in multiple fields within a document, by default only
--- the highest scoring field contributes to the document\'s overall
--- score. You can specify a 'tieBreaker' value to enable the matches in
--- lower-scoring fields to contribute to the document\'s score. That
--- way, if two documents have the same max field score for a particular
--- term, the score for the document that has matches in more fields
--- will be higher. The formula for calculating the score with a
--- tieBreaker is
--- '(max field score) + (tieBreaker) * (sum of the scores for the rest of the matching fields)'.
--- Set 'tieBreaker' to 0 to disregard all but the highest scoring field
--- (pure max): '\"tieBreaker\":0'. Set to 1 to sum the scores from all
--- fields (pure sum): '\"tieBreaker\":1'. Valid values: 0.0 to 1.0.
--- Default: 0.0. Valid for: 'dismax'.
+-- - 'defaultOperator': The default operator used to combine individual terms in the search string. For example: 'defaultOperator: \'or\''. For the 'dismax' parser, you specify a percentage that represents the percentage of terms in the search string (rounded down) that must match, rather than a default operator. A value of '0%' is the equivalent to OR, and a value of '100%' is equivalent to AND. The percentage must be specified as a value in the range 0-100 followed by the percent (%) symbol. For example, 'defaultOperator: 50%'. Valid values: 'and', 'or', a percentage in the range 0%-100% ('dismax'). Default: 'and' ('simple', 'structured', 'lucene') or '100' ('dismax'). Valid for: 'simple', 'structured', 'lucene', and 'dismax'.
+-- - 'fields': An array of the fields to search when no fields are specified in a search. If no fields are specified in a search and this option is not specified, all text and text-array fields are searched. You can specify a weight for each field to control the relative importance of each field when Amazon CloudSearch calculates relevance scores. To specify a field weight, append a caret ('^') symbol and the weight to the field name. For example, to boost the importance of the 'title' field over the 'description' field you could specify: '\"fields\":[\"title^5\",\"description\"]'. Valid values: The name of any configured field and an optional numeric value greater than zero. Default: All 'text' and 'text-array' fields. Valid for: 'simple', 'structured', 'lucene', and 'dismax'.
+-- - 'operators': An array of the operators or special characters you want to disable for the simple query parser. If you disable the 'and', 'or', or 'not' operators, the corresponding operators ('+', '|', '-') have no special meaning and are dropped from the search string. Similarly, disabling 'prefix' disables the wildcard operator ('*') and disabling 'phrase' disables the ability to search for phrases by enclosing phrases in double quotes. Disabling precedence disables the ability to control order of precedence using parentheses. Disabling 'near' disables the ability to use the ~ operator to perform a sloppy phrase search. Disabling the 'fuzzy' operator disables the ability to use the ~ operator to perform a fuzzy search. 'escape' disables the ability to use a backslash ('\\') to escape special characters within the search string. Disabling whitespace is an advanced option that prevents the parser from tokenizing on whitespace, which can be useful for Vietnamese. (It prevents Vietnamese words from being split incorrectly.) For example, you could disable all operators other than the phrase operator to support just simple term and phrase queries: '\"operators\":[\"and\",\"not\",\"or\", \"prefix\"]'. Valid values: 'and', 'escape', 'fuzzy', 'near', 'not', 'or', 'phrase', 'precedence', 'prefix', 'whitespace'. Default: All operators and special characters are enabled. Valid for: 'simple'.
+-- - 'phraseFields': An array of the 'text' or 'text-array' fields you want to use for phrase searches. When the terms in the search string appear in close proximity within a field, the field scores higher. You can specify a weight for each field to boost that score. The 'phraseSlop' option controls how much the matches can deviate from the search string and still be boosted. To specify a field weight, append a caret ('^') symbol and the weight to the field name. For example, to boost phrase matches in the 'title' field over the 'abstract' field, you could specify: '\"phraseFields\":[\"title^3\", \"plot\"]' Valid values: The name of any 'text' or 'text-array' field and an optional numeric value greater than zero. Default: No fields. If you don\'t specify any fields with 'phraseFields', proximity scoring is disabled even if 'phraseSlop' is specified. Valid for: 'dismax'.
+-- - 'phraseSlop': An integer value that specifies how much matches can deviate from the search phrase and still be boosted according to the weights specified in the 'phraseFields' option; for example, 'phraseSlop: 2'. You must also specify 'phraseFields' to enable proximity scoring. Valid values: positive integers. Default: 0. Valid for: 'dismax'.
+-- - 'explicitPhraseSlop': An integer value that specifies how much a match can deviate from the search phrase when the phrase is enclosed in double quotes in the search string. (Phrases that exceed this proximity distance are not considered a match.) For example, to specify a slop of three for dismax phrase queries, you would specify '\"explicitPhraseSlop\":3'. Valid values: positive integers. Default: 0. Valid for: 'dismax'.
+-- - 'tieBreaker': When a term in the search string is found in a document\'s field, a score is calculated for that field based on how common the word is in that field compared to other documents. If the term occurs in multiple fields within a document, by default only the highest scoring field contributes to the document\'s overall score. You can specify a 'tieBreaker' value to enable the matches in lower-scoring fields to contribute to the document\'s score. That way, if two documents have the same max field score for a particular term, the score for the document that has matches in more fields will be higher. The formula for calculating the score with a tieBreaker is '(max field score) + (tieBreaker) * (sum of the scores for the rest of the matching fields)'. Set 'tieBreaker' to 0 to disregard all but the highest scoring field (pure max): '\"tieBreaker\":0'. Set to 1 to sum the scores from all fields (pure sum): '\"tieBreaker\":1'. Valid values: 0.0 to 1.0. Default: 0.0. Valid for: 'dismax'.
seaQueryOptions :: Lens' Search (Maybe Text)
seaQueryOptions = lens _seaQueryOptions (\ s a -> s{_seaQueryOptions = a});
--- | Specifies a structured query that filters the results of a search
--- without affecting how the results are scored and sorted. You use
--- 'filterQuery' in conjunction with the 'query' parameter to filter the
--- documents that match the constraints specified in the 'query' parameter.
--- Specifying a filter controls only which matching documents are included
--- in the results, it has no effect on how they are scored and sorted. The
--- 'filterQuery' parameter supports the full structured query syntax.
---
--- For more information about using filters, see
--- <http://docs.aws.amazon.com/cloudsearch/latest/developerguide/filtering-results.html Filtering Matching Documents>
--- in the /Amazon CloudSearch Developer Guide/.
+-- | Specifies a structured query that filters the results of a search without affecting how the results are scored and sorted. You use 'filterQuery' in conjunction with the 'query' parameter to filter the documents that match the constraints specified in the 'query' parameter. Specifying a filter controls only which matching documents are included in the results, it has no effect on how they are scored and sorted. The 'filterQuery' parameter supports the full structured query syntax.
+--
+-- For more information about using filters, see <http://docs.aws.amazon.com/cloudsearch/latest/developerguide/filtering-results.html Filtering Matching Documents> in the /Amazon CloudSearch Developer Guide/.
seaFilterQuery :: Lens' Search (Maybe Text)
seaFilterQuery = lens _seaFilterQuery (\ s a -> s{_seaFilterQuery = a});
@@ -309,88 +183,41 @@ seaFilterQuery = lens _seaFilterQuery (\ s a -> s{_seaFilterQuery = a});
seaSize :: Lens' Search (Maybe Integer)
seaSize = lens _seaSize (\ s a -> s{_seaSize = a});
--- | Specifies which query parser to use to process the request. If
--- 'queryParser' is not specified, Amazon CloudSearch uses the 'simple'
--- query parser.
+-- | Specifies which query parser to use to process the request. If 'queryParser' is not specified, Amazon CloudSearch uses the 'simple' query parser.
--
-- Amazon CloudSearch supports four query parsers:
--
--- - 'simple': perform simple searches of 'text' and 'text-array' fields.
--- By default, the 'simple' query parser searches all 'text' and
--- 'text-array' fields. You can specify which fields to search by with
--- the 'queryOptions' parameter. If you prefix a search term with a
--- plus sign (+) documents must contain the term to be considered a
--- match. (This is the default, unless you configure the default
--- operator with the 'queryOptions' parameter.) You can use the '-'
--- (NOT), '|' (OR), and '*' (wildcard) operators to exclude particular
--- terms, find results that match any of the specified terms, or search
--- for a prefix. To search for a phrase rather than individual terms,
--- enclose the phrase in double quotes. For more information, see
--- <http://docs.aws.amazon.com/cloudsearch/latest/developerguide/searching-text.html Searching for Text>
--- in the /Amazon CloudSearch Developer Guide/.
--- - 'structured': perform advanced searches by combining multiple
--- expressions to define the search criteria. You can also search
--- within particular fields, search for values and ranges of values,
--- and use advanced options such as term boosting, 'matchall', and
--- 'near'. For more information, see
--- <http://docs.aws.amazon.com/cloudsearch/latest/developerguide/searching-compound-queries.html Constructing Compound Queries>
--- in the /Amazon CloudSearch Developer Guide/.
--- - 'lucene': search using the Apache Lucene query parser syntax. For
--- more information, see
--- <http://lucene.apache.org/core/4_6_0/queryparser/org/apache/lucene/queryparser/classic/package-summary.html#package_description Apache Lucene Query Parser Syntax>.
--- - 'dismax': search using the simplified subset of the Apache Lucene
--- query parser syntax defined by the DisMax query parser. For more
--- information, see
--- <http://wiki.apache.org/solr/DisMaxQParserPlugin#Query_Syntax DisMax Query Parser Syntax>.
+-- - 'simple': perform simple searches of 'text' and 'text-array' fields. By default, the 'simple' query parser searches all 'text' and 'text-array' fields. You can specify which fields to search by with the 'queryOptions' parameter. If you prefix a search term with a plus sign (+) documents must contain the term to be considered a match. (This is the default, unless you configure the default operator with the 'queryOptions' parameter.) You can use the '-' (NOT), '|' (OR), and '*' (wildcard) operators to exclude particular terms, find results that match any of the specified terms, or search for a prefix. To search for a phrase rather than individual terms, enclose the phrase in double quotes. For more information, see <http://docs.aws.amazon.com/cloudsearch/latest/developerguide/searching-text.html Searching for Text> in the /Amazon CloudSearch Developer Guide/.
+-- - 'structured': perform advanced searches by combining multiple expressions to define the search criteria. You can also search within particular fields, search for values and ranges of values, and use advanced options such as term boosting, 'matchall', and 'near'. For more information, see <http://docs.aws.amazon.com/cloudsearch/latest/developerguide/searching-compound-queries.html Constructing Compound Queries> in the /Amazon CloudSearch Developer Guide/.
+-- - 'lucene': search using the Apache Lucene query parser syntax. For more information, see <http://lucene.apache.org/core/4_6_0/queryparser/org/apache/lucene/queryparser/classic/package-summary.html#package_description Apache Lucene Query Parser Syntax>.
+-- - 'dismax': search using the simplified subset of the Apache Lucene query parser syntax defined by the DisMax query parser. For more information, see <http://wiki.apache.org/solr/DisMaxQParserPlugin#Query_Syntax DisMax Query Parser Syntax>.
seaQueryParser :: Lens' Search (Maybe QueryParser)
seaQueryParser = lens _seaQueryParser (\ s a -> s{_seaQueryParser = a});
--- | Specifies the offset of the first search hit you want to return. Note
--- that the result set is zero-based; the first result is at index 0. You
--- can specify either the 'start' or 'cursor' parameter in a request, they
--- are mutually exclusive.
+-- | Specifies the offset of the first search hit you want to return. Note that the result set is zero-based; the first result is at index 0. You can specify either the 'start' or 'cursor' parameter in a request, they are mutually exclusive.
--
--- For more information, see
--- <http://docs.aws.amazon.com/cloudsearch/latest/developerguide/paginating-results.html Paginating Results>
--- in the /Amazon CloudSearch Developer Guide/.
+-- For more information, see <http://docs.aws.amazon.com/cloudsearch/latest/developerguide/paginating-results.html Paginating Results> in the /Amazon CloudSearch Developer Guide/.
seaStart :: Lens' Search (Maybe Integer)
seaStart = lens _seaStart (\ s a -> s{_seaStart = a});
--- | Retrieves highlights for matches in the specified 'text' or 'text-array'
--- fields. Each specified field must be highlight enabled in the domain
--- configuration. The fields and options are specified in JSON using the
--- form
--- '{\"FIELD\":{\"OPTION\":VALUE,\"OPTION:\"STRING\"},\"FIELD\":{\"OPTION\":VALUE,\"OPTION\":\"STRING\"}}'.
+-- | Retrieves highlights for matches in the specified 'text' or 'text-array' fields. Each specified field must be highlight enabled in the domain configuration. The fields and options are specified in JSON using the form '{\"FIELD\":{\"OPTION\":VALUE,\"OPTION:\"STRING\"},\"FIELD\":{\"OPTION\":VALUE,\"OPTION\":\"STRING\"}}'.
--
-- You can specify the following highlight options:
--
--- - 'format': specifies the format of the data in the text field: 'text'
--- or 'html'. When data is returned as HTML, all non-alphanumeric
--- characters are encoded. The default is 'html'.
--- - 'max_phrases': specifies the maximum number of occurrences of the
--- search term(s) you want to highlight. By default, the first
--- occurrence is highlighted.
--- - 'pre_tag': specifies the string to prepend to an occurrence of a
--- search term. The default for HTML highlights is '&lt;em&gt;'. The
--- default for text highlights is '*'.
--- - 'post_tag': specifies the string to append to an occurrence of a
--- search term. The default for HTML highlights is '&lt;\/em&gt;'. The
--- default for text highlights is '*'.
---
--- If no highlight options are specified for a field, the returned field
--- text is treated as HTML and the first match is highlighted with emphasis
--- tags: '&lt;em>search-term&lt;\/em&gt;'.
---
--- For example, the following request retrieves highlights for the 'actors'
--- and 'title' fields.
+-- - 'format': specifies the format of the data in the text field: 'text' or 'html'. When data is returned as HTML, all non-alphanumeric characters are encoded. The default is 'html'.
+-- - 'max_phrases': specifies the maximum number of occurrences of the search term(s) you want to highlight. By default, the first occurrence is highlighted.
+-- - 'pre_tag': specifies the string to prepend to an occurrence of a search term. The default for HTML highlights is '&lt;em&gt;'. The default for text highlights is '*'.
+-- - 'post_tag': specifies the string to append to an occurrence of a search term. The default for HTML highlights is '&lt;\/em&gt;'. The default for text highlights is '*'.
+--
+-- If no highlight options are specified for a field, the returned field text is treated as HTML and the first match is highlighted with emphasis tags: '&lt;em>search-term&lt;\/em&gt;'.
+--
+-- For example, the following request retrieves highlights for the 'actors' and 'title' fields.
--
-- '{ \"actors\": {}, \"title\": {\"format\": \"text\",\"max_phrases\": 2,\"pre_tag\": \"\",\"post_tag\": \"\"} }'
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:
+-- | 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\":{}}'
--
@@ -398,105 +225,47 @@ seaHighlight = lens _seaHighlight (\ s a -> s{_seaHighlight = a});
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
--- 'desc') for each field; for example, 'year desc,title asc'. To use a
--- field to sort results, the field must be sort-enabled in the domain
--- configuration. Array type fields cannot be used for sorting. If no
--- 'sort' parameter is specified, results are sorted by their default
--- relevance scores in descending order: '_score desc'. You can also sort
--- by document ID ('_id asc') and version ('_version desc').
---
--- For more information, see
--- <http://docs.aws.amazon.com/cloudsearch/latest/developerguide/sorting-results.html Sorting Results>
--- in the /Amazon CloudSearch Developer Guide/.
+-- | 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 'desc') for each field; for example, 'year desc,title asc'. To use a field to sort results, the field must be sort-enabled in the domain configuration. Array type fields cannot be used for sorting. If no 'sort' parameter is specified, results are sorted by their default relevance scores in descending order: '_score desc'. You can also sort by document ID ('_id asc') and version ('_version desc').
+--
+-- For more information, see <http://docs.aws.amazon.com/cloudsearch/latest/developerguide/sorting-results.html Sorting Results> in the /Amazon CloudSearch Developer Guide/.
seaSort :: Lens' Search (Maybe Text)
seaSort = lens _seaSort (\ s a -> s{_seaSort = a});
--- | Specifies one or more fields for which to get facet information, and
--- options that control how the facet information is returned. Each
--- specified field must be facet-enabled in the domain configuration. The
--- fields and options are specified in JSON using the form
--- '{\"FIELD\":{\"OPTION\":VALUE,\"OPTION:\"STRING\"},\"FIELD\":{\"OPTION\":VALUE,\"OPTION\":\"STRING\"}}'.
+-- | Specifies one or more fields for which to get facet information, and options that control how the facet information is returned. Each specified field must be facet-enabled in the domain configuration. The fields and options are specified in JSON using the form '{\"FIELD\":{\"OPTION\":VALUE,\"OPTION:\"STRING\"},\"FIELD\":{\"OPTION\":VALUE,\"OPTION\":\"STRING\"}}'.
--
-- You can specify the following faceting options:
--
--- - 'buckets' specifies an array of the facet values or ranges to count.
--- Ranges are specified using the same syntax that you use to search
--- for a range of values. For more information, see
--- <http://docs.aws.amazon.com/cloudsearch/latest/developerguide/searching-ranges.html Searching for a Range of Values>
--- in the /Amazon CloudSearch Developer Guide/. Buckets are returned in
--- the order they are specified in the request. The 'sort' and 'size'
--- options are not valid if you specify 'buckets'.
---
--- - 'size' specifies the maximum number of facets to include in the
--- results. By default, Amazon CloudSearch returns counts for the top
--- 10. The 'size' parameter is only valid when you specify the 'sort'
--- option; it cannot be used in conjunction with 'buckets'.
---
--- - 'sort' specifies how you want to sort the facets in the results:
--- 'bucket' or 'count'. Specify 'bucket' to sort alphabetically or
--- numerically by facet value (in ascending order). Specify 'count' to
--- sort by the facet counts computed for each facet value (in
--- descending order). To retrieve facet counts for particular values or
--- ranges of values, use the 'buckets' option instead of 'sort'.
---
--- If no facet options are specified, facet counts are computed for all
--- field values, the facets are sorted by facet count, and the top 10
--- facets are returned in the results.
---
--- To count particular buckets of values, use the 'buckets' option. For
--- example, the following request uses the 'buckets' option to calculate
--- and return facet counts by decade.
+-- - 'buckets' specifies an array of the facet values or ranges to count. Ranges are specified using the same syntax that you use to search for a range of values. For more information, see <http://docs.aws.amazon.com/cloudsearch/latest/developerguide/searching-ranges.html Searching for a Range of Values> in the /Amazon CloudSearch Developer Guide/. Buckets are returned in the order they are specified in the request. The 'sort' and 'size' options are not valid if you specify 'buckets'.
+--
+-- - 'size' specifies the maximum number of facets to include in the results. By default, Amazon CloudSearch returns counts for the top 10. The 'size' parameter is only valid when you specify the 'sort' option; it cannot be used in conjunction with 'buckets'.
+--
+-- - 'sort' specifies how you want to sort the facets in the results: 'bucket' or 'count'. Specify 'bucket' to sort alphabetically or numerically by facet value (in ascending order). Specify 'count' to sort by the facet counts computed for each facet value (in descending order). To retrieve facet counts for particular values or ranges of values, use the 'buckets' option instead of 'sort'.
+--
+-- If no facet options are specified, facet counts are computed for all field values, the facets are sorted by facet count, and the top 10 facets are returned in the results.
+--
+-- To count particular buckets of values, use the 'buckets' option. For example, the following request uses the 'buckets' option to calculate and return facet counts by decade.
--
-- ' {\"year\":{\"buckets\":[\"[1970,1979]\",\"[1980,1989]\",\"[1990,1999]\",\"[2000,2009]\",\"[2010,}\"]}} '
--
--- To sort facets by facet count, use the 'count' option. For example, the
--- following request sets the 'sort' option to 'count' to sort the facet
--- values by facet count, with the facet values that have the most matching
--- documents listed first. Setting the 'size' option to 3 returns only the
--- top three facet values.
+-- To sort facets by facet count, use the 'count' option. For example, the following request sets the 'sort' option to 'count' to sort the facet values by facet count, with the facet values that have the most matching documents listed first. Setting the 'size' option to 3 returns only the top three facet values.
--
-- ' {\"year\":{\"sort\":\"count\",\"size\":3}} '
--
--- To sort the facets by value, use the 'bucket' option. For example, the
--- following request sets the 'sort' option to 'bucket' to sort the facet
--- values numerically by year, with earliest year listed first.
+-- To sort the facets by value, use the 'bucket' option. For example, the following request sets the 'sort' option to 'bucket' to sort the facet values numerically by year, with earliest year listed first.
--
-- ' {\"year\":{\"sort\":\"bucket\"}} '
--
--- For more information, see
--- <http://docs.aws.amazon.com/cloudsearch/latest/developerguide/faceting.html Getting and Using Facet Information>
--- in the /Amazon CloudSearch Developer Guide/.
+-- For more information, see <http://docs.aws.amazon.com/cloudsearch/latest/developerguide/faceting.html Getting and Using Facet Information> in the /Amazon CloudSearch Developer Guide/.
seaFacet :: Lens' Search (Maybe Text)
seaFacet = lens _seaFacet (\ s a -> s{_seaFacet = a});
--- | Enables partial results to be returned if one or more index partitions
--- are unavailable. When your search index is partitioned across multiple
--- search instances, by default Amazon CloudSearch only returns results if
--- every partition can be queried. This means that the failure of a single
--- search instance can result in 5xx (internal server) errors. When you
--- enable partial results, Amazon CloudSearch returns whatever results are
--- available and includes the percentage of documents searched in the
--- search results (percent-searched). This enables you to more gracefully
--- degrade your users\' search experience. For example, rather than
--- displaying no results, you could display the partial results and a
--- message indicating that the results might be incomplete due to a
--- temporary system outage.
+-- | Enables partial results to be returned if one or more index partitions are unavailable. When your search index is partitioned across multiple search instances, by default Amazon CloudSearch only returns results if every partition can be queried. This means that the failure of a single search instance can result in 5xx (internal server) errors. When you enable partial results, Amazon CloudSearch returns whatever results are available and includes the percentage of documents searched in the search results (percent-searched). This enables you to more gracefully degrade your users\' search experience. For example, rather than displaying no results, you could display the partial results and a message indicating that the results might be incomplete due to a temporary system outage.
seaPartial :: Lens' Search (Maybe Bool)
seaPartial = lens _seaPartial (\ s a -> s{_seaPartial = a});
--- | Specifies the search criteria for the request. How you specify the
--- search criteria depends on the query parser used for the request and the
--- parser options specified in the 'queryOptions' parameter. By default,
--- the 'simple' query parser is used to process requests. To use the
--- 'structured', 'lucene', or 'dismax' query parser, you must also specify
--- the 'queryParser' parameter.
+-- | Specifies the search criteria for the request. How you specify the search criteria depends on the query parser used for the request and the parser options specified in the 'queryOptions' parameter. By default, the 'simple' query parser is used to process requests. To use the 'structured', 'lucene', or 'dismax' query parser, you must also specify the 'queryParser' parameter.
--
--- For more information about specifying search criteria, see
--- <http://docs.aws.amazon.com/cloudsearch/latest/developerguide/searching.html Searching Your Data>
--- in the /Amazon CloudSearch Developer Guide/.
+-- For more information about specifying search criteria, see <http://docs.aws.amazon.com/cloudsearch/latest/developerguide/searching.html Searching Your Data> in the /Amazon CloudSearch Developer Guide/.
seaQuery :: Lens' Search Text
seaQuery = lens _seaQuery (\ s a -> s{_seaQuery = a});
@@ -539,9 +308,7 @@ instance ToQuery Search where
"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
--- facet information.
+-- | The result of a 'Search' request. Contains the documents that match the specified search criteria and any requested fields, highlights, and facet information.
--
-- /See:/ 'searchResponse' smart constructor.
data SearchResponse = SearchResponse'
diff --git a/gen/Network/AWS/CloudSearchDomains/Suggest.hs b/gen/Network/AWS/CloudSearchDomains/Suggest.hs
index b96ef6c..8433b3b 100644
--- a/gen/Network/AWS/CloudSearchDomains/Suggest.hs
+++ b/gen/Network/AWS/CloudSearchDomains/Suggest.hs
@@ -18,25 +18,11 @@
-- Stability : auto-generated
-- Portability : non-portable (GHC extensions)
--
--- Retrieves autocomplete suggestions for a partial query string. You can
--- use suggestions enable you to display likely matches before users finish
--- typing. In Amazon CloudSearch, suggestions are based on the contents of
--- a particular text field. When you request suggestions, Amazon
--- CloudSearch finds all of the documents whose values in the suggester
--- field start with the specified query string. The beginning of the field
--- must match the query string to be considered a match.
+-- Retrieves autocomplete suggestions for a partial query string. You can use suggestions enable you to display likely matches before users finish typing. In Amazon CloudSearch, suggestions are based on the contents of a particular text field. When you request suggestions, Amazon CloudSearch finds all of the documents whose values in the suggester field start with the specified query string. The beginning of the field must match the query string to be considered a match.
--
--- For more information about configuring suggesters and retrieving
--- suggestions, see
--- <http://docs.aws.amazon.com/cloudsearch/latest/developerguide/getting-suggestions.html Getting Suggestions>
--- in the /Amazon CloudSearch Developer Guide/.
+-- For more information about configuring suggesters and retrieving suggestions, see <http://docs.aws.amazon.com/cloudsearch/latest/developerguide/getting-suggestions.html Getting Suggestions> in the /Amazon CloudSearch Developer Guide/.
--
--- The endpoint for submitting 'Suggest' requests is domain-specific. You
--- submit suggest requests to a domain\'s search endpoint. To get the
--- search 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.
+-- The endpoint for submitting 'Suggest' requests is domain-specific. You submit suggest requests to a domain\'s search endpoint. To get the search 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.
module Network.AWS.CloudSearchDomains.Suggest
(
-- * Creating a Request
@@ -166,8 +152,7 @@ suggestResponse pResponseStatus_ =
srsSuggest :: Lens' SuggestResponse (Maybe SuggestModel)
srsSuggest = lens _srsSuggest (\ s a -> s{_srsSuggest = a});
--- | The status of a 'SuggestRequest'. Contains the resource ID ('rid') and
--- how long it took to process the request ('timems').
+-- | The status of a 'SuggestRequest'. Contains the resource ID ('rid') and how long it took to process the request ('timems').
srsStatus :: Lens' SuggestResponse (Maybe SuggestStatus)
srsStatus = lens _srsStatus (\ s a -> s{_srsStatus = a});
diff --git a/gen/Network/AWS/CloudSearchDomains/Types.hs b/gen/Network/AWS/CloudSearchDomains/Types.hs
index b7ddaf1..2b3f0c8 100644
--- a/gen/Network/AWS/CloudSearchDomains/Types.hs
+++ b/gen/Network/AWS/CloudSearchDomains/Types.hs
@@ -136,12 +136,10 @@ cloudSearchDomains =
| has (hasStatus 509) e = Just "limit_exceeded"
| otherwise = Nothing
--- | Information about any problems encountered while processing an upload
--- request.
+-- | Information about any problems encountered while processing an upload request.
_DocumentServiceException :: AsError a => Getting (First ServiceError) a ServiceError
_DocumentServiceException = _ServiceError . hasCode "DocumentServiceException"
--- | Information about any problems encountered while processing a search
--- request.
+-- | Information about any problems encountered while processing a search request.
_SearchException :: AsError a => Getting (First ServiceError) a ServiceError
_SearchException = _ServiceError . hasCode "SearchException"
diff --git a/gen/Network/AWS/CloudSearchDomains/Types/Product.hs b/gen/Network/AWS/CloudSearchDomains/Types/Product.hs
index a95004b..486bf15 100644
--- a/gen/Network/AWS/CloudSearchDomains/Types/Product.hs
+++ b/gen/Network/AWS/CloudSearchDomains/Types/Product.hs
@@ -48,8 +48,7 @@ bucket =
bValue :: Lens' Bucket (Maybe Text)
bValue = lens _bValue (\ s a -> s{_bValue = a});
--- | The number of hits that contain the facet value in the specified facet
--- field.
+-- | The number of hits that contain the facet value in the specified facet field.
bCount :: Lens' Bucket (Maybe Integer)
bCount = lens _bCount (\ s a -> s{_bCount = a});
@@ -95,8 +94,7 @@ instance Hashable BucketInfo
instance NFData BucketInfo
--- | A warning returned by the document service when an issue is discovered
--- while processing an upload request.
+-- | A warning returned by the document service when an issue is discovered while processing an upload request.
--
-- /See:/ 'documentServiceWarning' smart constructor.
newtype DocumentServiceWarning = DocumentServiceWarning'
@@ -178,50 +176,31 @@ fieldStats =
-- | 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 <http://tools.ietf.org/html/rfc3339 IETF RFC3339>:
--- yyyy-mm-ddTHH:mm:ss.SSSZ.
+-- 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 <http://tools.ietf.org/html/rfc3339 IETF RFC3339>: 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.
+-- | 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 <http://tools.ietf.org/html/rfc3339 IETF RFC3339>:
--- yyyy-mm-ddTHH:mm:ss.SSSZ.
+-- 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 <http://tools.ietf.org/html/rfc3339 IETF RFC3339>: 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.
+-- | 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.
+-- | 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.
+-- | 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 <http://tools.ietf.org/html/rfc3339 IETF RFC3339>:
--- yyyy-mm-ddTHH:mm:ss.SSSZ.
+-- 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 <http://tools.ietf.org/html/rfc3339 IETF RFC3339>: yyyy-mm-ddTHH:mm:ss.SSSZ.
fsMin :: Lens' FieldStats (Maybe Text)
fsMin = lens _fsMin (\ s a -> s{_fsMin = a});
@@ -229,8 +208,7 @@ fsMin = lens _fsMin (\ s a -> s{_fsMin = a});
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.
+-- | 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});
@@ -281,8 +259,7 @@ hit =
, _hitFields = Nothing
}
--- | The expressions returned from a document that matches the search
--- request.
+-- | The expressions returned from a document that matches the search request.
hitExprs :: Lens' Hit (HashMap Text Text)
hitExprs = lens _hitExprs (\ s a -> s{_hitExprs = a}) . _Default . _Map;
@@ -342,8 +319,7 @@ hits =
, _hFound = Nothing
}
--- | A cursor that can be used to retrieve the next set of matching documents
--- when you want to page through a large result set.
+-- | A cursor that can be used to retrieve the next set of matching documents when you want to page through a large result set.
hCursor :: Lens' Hits (Maybe Text)
hCursor = lens _hCursor (\ s a -> s{_hCursor = a});
@@ -372,8 +348,7 @@ instance Hashable Hits
instance NFData Hits
--- | Contains the resource id ('rid') and the time it took to process the
--- request ('timems').
+-- | Contains the resource id ('rid') and the time it took to process the request ('timems').
--
-- /See:/ 'searchStatus' smart constructor.
data SearchStatus = SearchStatus'
@@ -414,8 +389,7 @@ instance Hashable SearchStatus
instance NFData SearchStatus
--- | Container for the suggestion information returned in a
--- 'SuggestResponse'.
+-- | Container for the suggestion information returned in a 'SuggestResponse'.
--
-- /See:/ 'suggestModel' smart constructor.
data SuggestModel = SuggestModel'
@@ -466,8 +440,7 @@ instance Hashable SuggestModel
instance NFData SuggestModel
--- | Contains the resource id ('rid') and the time it took to process the
--- request ('timems').
+-- | Contains the resource id ('rid') and the time it took to process the request ('timems').
--
-- /See:/ 'suggestStatus' smart constructor.
data SuggestStatus = SuggestStatus'
@@ -509,8 +482,7 @@ instance Hashable SuggestStatus
instance NFData SuggestStatus
--- | An autocomplete suggestion that matches the query string specified in a
--- 'SuggestRequest'.
+-- | An autocomplete suggestion that matches the query string specified in a 'SuggestRequest'.
--
-- /See:/ 'suggestionMatch' smart constructor.
data SuggestionMatch = SuggestionMatch'
@@ -537,8 +509,7 @@ suggestionMatch =
, _smId = Nothing
}
--- | The string that matches the query string specified in the
--- 'SuggestRequest'.
+-- | The string that matches the query string specified in the 'SuggestRequest'.
smSuggestion :: Lens' SuggestionMatch (Maybe Text)
smSuggestion = lens _smSuggestion (\ s a -> s{_smSuggestion = a});
diff --git a/gen/Network/AWS/CloudSearchDomains/UploadDocuments.hs b/gen/Network/AWS/CloudSearchDomains/UploadDocuments.hs
index 7dec2e4..411b7c8 100644
--- a/gen/Network/AWS/CloudSearchDomains/UploadDocuments.hs
+++ b/gen/Network/AWS/CloudSearchDomains/UploadDocuments.hs
@@ -18,32 +18,11 @@
-- Stability : auto-generated
-- Portability : non-portable (GHC extensions)
--
--- Posts a batch of documents to a search domain for indexing. A document
--- batch is a collection of add and delete operations that represent the
--- documents you want to add, update, or delete from your domain. Batches
--- can be described in either JSON or XML. Each item that you want Amazon
--- CloudSearch to return as a search result (such as a product) is
--- represented as a document. Every document has a unique ID and one or
--- more fields that contain the data that you want to search and return in
--- results. Individual documents cannot contain more than 1 MB of data. The
--- entire batch cannot exceed 5 MB. To get the best possible upload
--- performance, group add and delete operations in batches that are close
--- the 5 MB limit. Submitting a large volume of single-document batches can
--- overload a domain\'s document service.
+-- Posts a batch of documents to a search domain for indexing. A document batch is a collection of add and delete operations that represent the documents you want to add, update, or delete from your domain. Batches can be described in either JSON or XML. Each item that you want Amazon CloudSearch to return as a search result (such as a product) is represented as a document. Every document has a unique ID and one or more fields that contain the data that you want to search and return in results. Individual documents cannot contain more than 1 MB of data. The entire batch cannot exceed 5 MB. To get the best possible upload performance, group add and delete operations in batches that are close the 5 MB limit. Submitting a large volume of single-document batches can overload a domain\'s document service.
--
--- The endpoint for submitting 'UploadDocuments' requests is
--- domain-specific. To get the document 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.
+-- The endpoint for submitting 'UploadDocuments' requests is domain-specific. To get the document 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.
--
--- For more information about formatting your data for Amazon CloudSearch,
--- see
--- <http://docs.aws.amazon.com/cloudsearch/latest/developerguide/preparing-data.html Preparing Your Data>
--- in the /Amazon CloudSearch Developer Guide/. For more information about
--- uploading data for indexing, see
--- <http://docs.aws.amazon.com/cloudsearch/latest/developerguide/uploading-data.html Uploading Data>
--- in the /Amazon CloudSearch Developer Guide/.
+-- For more information about formatting your data for Amazon CloudSearch, see <http://docs.aws.amazon.com/cloudsearch/latest/developerguide/preparing-data.html Preparing Your Data> in the /Amazon CloudSearch Developer Guide/. For more information about uploading data for indexing, see <http://docs.aws.amazon.com/cloudsearch/latest/developerguide/uploading-data.html Uploading Data> in the /Amazon CloudSearch Developer Guide/.
module Network.AWS.CloudSearchDomains.UploadDocuments
(
-- * Creating a Request
@@ -96,8 +75,7 @@ uploadDocuments pContentType_ pDocuments_ =
, _udDocuments = pDocuments_
}
--- | The format of the batch you are uploading. Amazon CloudSearch supports
--- two document batch formats:
+-- | The format of the batch you are uploading. Amazon CloudSearch supports two document batch formats:
--
-- - application\/json
-- - application\/xml
@@ -180,8 +158,7 @@ udrsStatus = lens _udrsStatus (\ s a -> s{_udrsStatus = a});
udrsAdds :: Lens' UploadDocumentsResponse (Maybe Integer)
udrsAdds = lens _udrsAdds (\ s a -> s{_udrsAdds = a});
--- | Any warnings returned by the document service about the documents being
--- uploaded.
+-- | Any warnings returned by the document service about the documents being uploaded.
udrsWarnings :: Lens' UploadDocumentsResponse [DocumentServiceWarning]
udrsWarnings = lens _udrsWarnings (\ s a -> s{_udrsWarnings = a}) . _Default . _Coerce;
diff --git a/test/Test/AWS/Gen/CloudSearchDomains.hs b/test/Test/AWS/Gen/CloudSearchDomains.hs
index 7846fe8..56ce8c1 100644
--- a/test/Test/AWS/Gen/CloudSearchDomains.hs
+++ b/test/Test/AWS/Gen/CloudSearchDomains.hs
@@ -28,25 +28,25 @@ import Test.AWS.CloudSearchDomains.Internal
-- fixtures :: TestTree
-- fixtures =
-- [ testGroup "request"
--- [ testSuggest $
+-- [ requestSuggest $
-- suggest
--
--- , testUploadDocuments $
+-- , requestUploadDocuments $
-- uploadDocuments
--
--- , testSearch $
+-- , requestSearch $
-- search
--
-- ]
-- , testGroup "response"
--- [ testSuggestResponse $
+-- [ responseSuggest $
-- suggestResponse
--
--- , testUploadDocumentsResponse $
+-- , responseUploadDocuments $
-- uploadDocumentsResponse
--
--- , testSearchResponse $
+-- , responseSearch $
-- searchResponse
--
-- ]
@@ -54,34 +54,34 @@ import Test.AWS.CloudSearchDomains.Internal
-- Requests
-testSuggest :: Suggest -> TestTree
-testSuggest = req
+requestSuggest :: Suggest -> TestTree
+requestSuggest = req
"Suggest"
"fixture/Suggest.yaml"
-testSearch :: Search -> TestTree
-testSearch = req
+requestSearch :: Search -> TestTree
+requestSearch = req
"Search"
"fixture/Search.yaml"
-- Responses
-testSuggestResponse :: SuggestResponse -> TestTree
-testSuggestResponse = res
+responseSuggest :: SuggestResponse -> TestTree
+responseSuggest = res
"SuggestResponse"
"fixture/SuggestResponse.proto"
cloudSearchDomains
(Proxy :: Proxy Suggest)
-testUploadDocumentsResponse :: UploadDocumentsResponse -> TestTree
-testUploadDocumentsResponse = res
+responseUploadDocuments :: UploadDocumentsResponse -> TestTree
+responseUploadDocuments = res
"UploadDocumentsResponse"
"fixture/UploadDocumentsResponse.proto"
cloudSearchDomains
(Proxy :: Proxy UploadDocuments)
-testSearchResponse :: SearchResponse -> TestTree
-testSearchResponse = res
+responseSearch :: SearchResponse -> TestTree
+responseSearch = res
"SearchResponse"
"fixture/SearchResponse.proto"
cloudSearchDomains