guppy_basecaller: env/lib/python3.7/site-packages/boto/cloudsearchdomain/layer1.py annotate

author	shellac
date	Sat, 02 May 2020 07:14:21 -0400
parents
children

rev	line source
0 26e78fe6e8c4 "planemo upload commit c699937486c35866861690329de38ec1a5d9f783" shellac parents: diff changeset	1 # Copyright (c) 2014 Amazon.com, Inc. or its affiliates. All Rights Reserved
26e78fe6e8c4 "planemo upload commit c699937486c35866861690329de38ec1a5d9f783" shellac parents: diff changeset	2 #
26e78fe6e8c4 "planemo upload commit c699937486c35866861690329de38ec1a5d9f783" shellac parents: diff changeset	3 # Permission is hereby granted, free of charge, to any person obtaining a
26e78fe6e8c4 "planemo upload commit c699937486c35866861690329de38ec1a5d9f783" shellac parents: diff changeset	4 # copy of this software and associated documentation files (the
26e78fe6e8c4 "planemo upload commit c699937486c35866861690329de38ec1a5d9f783" shellac parents: diff changeset	5 # "Software"), to deal in the Software without restriction, including
26e78fe6e8c4 "planemo upload commit c699937486c35866861690329de38ec1a5d9f783" shellac parents: diff changeset	6 # without limitation the rights to use, copy, modify, merge, publish, dis-
26e78fe6e8c4 "planemo upload commit c699937486c35866861690329de38ec1a5d9f783" shellac parents: diff changeset	7 # tribute, sublicense, and/or sell copies of the Software, and to permit
26e78fe6e8c4 "planemo upload commit c699937486c35866861690329de38ec1a5d9f783" shellac parents: diff changeset	8 # persons to whom the Software is furnished to do so, subject to the fol-
26e78fe6e8c4 "planemo upload commit c699937486c35866861690329de38ec1a5d9f783" shellac parents: diff changeset	9 # lowing conditions:
26e78fe6e8c4 "planemo upload commit c699937486c35866861690329de38ec1a5d9f783" shellac parents: diff changeset	10 #
26e78fe6e8c4 "planemo upload commit c699937486c35866861690329de38ec1a5d9f783" shellac parents: diff changeset	11 # The above copyright notice and this permission notice shall be included
26e78fe6e8c4 "planemo upload commit c699937486c35866861690329de38ec1a5d9f783" shellac parents: diff changeset	12 # in all copies or substantial portions of the Software.
26e78fe6e8c4 "planemo upload commit c699937486c35866861690329de38ec1a5d9f783" shellac parents: diff changeset	13 #
26e78fe6e8c4 "planemo upload commit c699937486c35866861690329de38ec1a5d9f783" shellac parents: diff changeset	14 # THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS
26e78fe6e8c4 "planemo upload commit c699937486c35866861690329de38ec1a5d9f783" shellac parents: diff changeset	15 # OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABIL-
26e78fe6e8c4 "planemo upload commit c699937486c35866861690329de38ec1a5d9f783" shellac parents: diff changeset	16 # ITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT
26e78fe6e8c4 "planemo upload commit c699937486c35866861690329de38ec1a5d9f783" shellac parents: diff changeset	17 # SHALL THE AUTHOR BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY,
26e78fe6e8c4 "planemo upload commit c699937486c35866861690329de38ec1a5d9f783" shellac parents: diff changeset	18 # WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
26e78fe6e8c4 "planemo upload commit c699937486c35866861690329de38ec1a5d9f783" shellac parents: diff changeset	19 # OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS
26e78fe6e8c4 "planemo upload commit c699937486c35866861690329de38ec1a5d9f783" shellac parents: diff changeset	20 # IN THE SOFTWARE.
26e78fe6e8c4 "planemo upload commit c699937486c35866861690329de38ec1a5d9f783" shellac parents: diff changeset	21 #
26e78fe6e8c4 "planemo upload commit c699937486c35866861690329de38ec1a5d9f783" shellac parents: diff changeset	22 from boto.compat import json
26e78fe6e8c4 "planemo upload commit c699937486c35866861690329de38ec1a5d9f783" shellac parents: diff changeset	23 from boto.exception import JSONResponseError
26e78fe6e8c4 "planemo upload commit c699937486c35866861690329de38ec1a5d9f783" shellac parents: diff changeset	24 from boto.connection import AWSAuthConnection
26e78fe6e8c4 "planemo upload commit c699937486c35866861690329de38ec1a5d9f783" shellac parents: diff changeset	25 from boto.regioninfo import RegionInfo
26e78fe6e8c4 "planemo upload commit c699937486c35866861690329de38ec1a5d9f783" shellac parents: diff changeset	26 from boto.cloudsearchdomain import exceptions
26e78fe6e8c4 "planemo upload commit c699937486c35866861690329de38ec1a5d9f783" shellac parents: diff changeset	27
26e78fe6e8c4 "planemo upload commit c699937486c35866861690329de38ec1a5d9f783" shellac parents: diff changeset	28
26e78fe6e8c4 "planemo upload commit c699937486c35866861690329de38ec1a5d9f783" shellac parents: diff changeset	29 class CloudSearchDomainConnection(AWSAuthConnection):
26e78fe6e8c4 "planemo upload commit c699937486c35866861690329de38ec1a5d9f783" shellac parents: diff changeset	30 """
26e78fe6e8c4 "planemo upload commit c699937486c35866861690329de38ec1a5d9f783" shellac parents: diff changeset	31 You use the AmazonCloudSearch2013 API to upload documents to a
26e78fe6e8c4 "planemo upload commit c699937486c35866861690329de38ec1a5d9f783" shellac parents: diff changeset	32 search domain and search those documents.
26e78fe6e8c4 "planemo upload commit c699937486c35866861690329de38ec1a5d9f783" shellac parents: diff changeset	33
26e78fe6e8c4 "planemo upload commit c699937486c35866861690329de38ec1a5d9f783" shellac parents: diff changeset	34 The endpoints for submitting `UploadDocuments`, `Search`, and
26e78fe6e8c4 "planemo upload commit c699937486c35866861690329de38ec1a5d9f783" shellac parents: diff changeset	35 `Suggest` requests are domain-specific. To get the endpoints for
26e78fe6e8c4 "planemo upload commit c699937486c35866861690329de38ec1a5d9f783" shellac parents: diff changeset	36 your domain, use the Amazon CloudSearch configuration service
26e78fe6e8c4 "planemo upload commit c699937486c35866861690329de38ec1a5d9f783" shellac parents: diff changeset	37 `DescribeDomains` action. The domain endpoints are also displayed
26e78fe6e8c4 "planemo upload commit c699937486c35866861690329de38ec1a5d9f783" shellac parents: diff changeset	38 on the domain dashboard in the Amazon CloudSearch console. You
26e78fe6e8c4 "planemo upload commit c699937486c35866861690329de38ec1a5d9f783" shellac parents: diff changeset	39 submit suggest requests to the search endpoint.
26e78fe6e8c4 "planemo upload commit c699937486c35866861690329de38ec1a5d9f783" shellac parents: diff changeset	40
26e78fe6e8c4 "planemo upload commit c699937486c35866861690329de38ec1a5d9f783" shellac parents: diff changeset	41 For more information, see the `Amazon CloudSearch Developer
26e78fe6e8c4 "planemo upload commit c699937486c35866861690329de38ec1a5d9f783" shellac parents: diff changeset	42 Guide`_.
26e78fe6e8c4 "planemo upload commit c699937486c35866861690329de38ec1a5d9f783" shellac parents: diff changeset	43 """
26e78fe6e8c4 "planemo upload commit c699937486c35866861690329de38ec1a5d9f783" shellac parents: diff changeset	44 APIVersion = "2013-01-01"
26e78fe6e8c4 "planemo upload commit c699937486c35866861690329de38ec1a5d9f783" shellac parents: diff changeset	45 AuthServiceName = 'cloudsearch'
26e78fe6e8c4 "planemo upload commit c699937486c35866861690329de38ec1a5d9f783" shellac parents: diff changeset	46 DefaultRegionName = "us-east-1"
26e78fe6e8c4 "planemo upload commit c699937486c35866861690329de38ec1a5d9f783" shellac parents: diff changeset	47 DefaultRegionEndpoint = "cloudsearch.us-east-1.amazonaws.com"
26e78fe6e8c4 "planemo upload commit c699937486c35866861690329de38ec1a5d9f783" shellac parents: diff changeset	48 ResponseError = JSONResponseError
26e78fe6e8c4 "planemo upload commit c699937486c35866861690329de38ec1a5d9f783" shellac parents: diff changeset	49
26e78fe6e8c4 "planemo upload commit c699937486c35866861690329de38ec1a5d9f783" shellac parents: diff changeset	50 _faults = {
26e78fe6e8c4 "planemo upload commit c699937486c35866861690329de38ec1a5d9f783" shellac parents: diff changeset	51 "SearchException": exceptions.SearchException,
26e78fe6e8c4 "planemo upload commit c699937486c35866861690329de38ec1a5d9f783" shellac parents: diff changeset	52 "DocumentServiceException": exceptions.DocumentServiceException,
26e78fe6e8c4 "planemo upload commit c699937486c35866861690329de38ec1a5d9f783" shellac parents: diff changeset	53 }
26e78fe6e8c4 "planemo upload commit c699937486c35866861690329de38ec1a5d9f783" shellac parents: diff changeset	54
26e78fe6e8c4 "planemo upload commit c699937486c35866861690329de38ec1a5d9f783" shellac parents: diff changeset	55 def __init__(self, **kwargs):
26e78fe6e8c4 "planemo upload commit c699937486c35866861690329de38ec1a5d9f783" shellac parents: diff changeset	56 region = kwargs.get('region')
26e78fe6e8c4 "planemo upload commit c699937486c35866861690329de38ec1a5d9f783" shellac parents: diff changeset	57 if not region:
26e78fe6e8c4 "planemo upload commit c699937486c35866861690329de38ec1a5d9f783" shellac parents: diff changeset	58 region = RegionInfo(self, self.DefaultRegionName,
26e78fe6e8c4 "planemo upload commit c699937486c35866861690329de38ec1a5d9f783" shellac parents: diff changeset	59 self.DefaultRegionEndpoint)
26e78fe6e8c4 "planemo upload commit c699937486c35866861690329de38ec1a5d9f783" shellac parents: diff changeset	60 else:
26e78fe6e8c4 "planemo upload commit c699937486c35866861690329de38ec1a5d9f783" shellac parents: diff changeset	61 del kwargs['region']
26e78fe6e8c4 "planemo upload commit c699937486c35866861690329de38ec1a5d9f783" shellac parents: diff changeset	62 if kwargs.get('host', None) is None:
26e78fe6e8c4 "planemo upload commit c699937486c35866861690329de38ec1a5d9f783" shellac parents: diff changeset	63 raise ValueError(
26e78fe6e8c4 "planemo upload commit c699937486c35866861690329de38ec1a5d9f783" shellac parents: diff changeset	64 'The argument, host, must be provided when creating a '
26e78fe6e8c4 "planemo upload commit c699937486c35866861690329de38ec1a5d9f783" shellac parents: diff changeset	65 'CloudSearchDomainConnection because its methods require the '
26e78fe6e8c4 "planemo upload commit c699937486c35866861690329de38ec1a5d9f783" shellac parents: diff changeset	66 'specific domain\'s endpoint in order to successfully make '
26e78fe6e8c4 "planemo upload commit c699937486c35866861690329de38ec1a5d9f783" shellac parents: diff changeset	67 'requests to that CloudSearch Domain.'
26e78fe6e8c4 "planemo upload commit c699937486c35866861690329de38ec1a5d9f783" shellac parents: diff changeset	68 )
26e78fe6e8c4 "planemo upload commit c699937486c35866861690329de38ec1a5d9f783" shellac parents: diff changeset	69 super(CloudSearchDomainConnection, self).__init__(**kwargs)
26e78fe6e8c4 "planemo upload commit c699937486c35866861690329de38ec1a5d9f783" shellac parents: diff changeset	70 self.region = region
26e78fe6e8c4 "planemo upload commit c699937486c35866861690329de38ec1a5d9f783" shellac parents: diff changeset	71
26e78fe6e8c4 "planemo upload commit c699937486c35866861690329de38ec1a5d9f783" shellac parents: diff changeset	72 def _required_auth_capability(self):
26e78fe6e8c4 "planemo upload commit c699937486c35866861690329de38ec1a5d9f783" shellac parents: diff changeset	73 return ['hmac-v4']
26e78fe6e8c4 "planemo upload commit c699937486c35866861690329de38ec1a5d9f783" shellac parents: diff changeset	74
26e78fe6e8c4 "planemo upload commit c699937486c35866861690329de38ec1a5d9f783" shellac parents: diff changeset	75 def search(self, query, cursor=None, expr=None, facet=None,
26e78fe6e8c4 "planemo upload commit c699937486c35866861690329de38ec1a5d9f783" shellac parents: diff changeset	76 filter_query=None, highlight=None, partial=None,
26e78fe6e8c4 "planemo upload commit c699937486c35866861690329de38ec1a5d9f783" shellac parents: diff changeset	77 query_options=None, query_parser=None, ret=None, size=None,
26e78fe6e8c4 "planemo upload commit c699937486c35866861690329de38ec1a5d9f783" shellac parents: diff changeset	78 sort=None, start=None):
26e78fe6e8c4 "planemo upload commit c699937486c35866861690329de38ec1a5d9f783" shellac parents: diff changeset	79 """
26e78fe6e8c4 "planemo upload commit c699937486c35866861690329de38ec1a5d9f783" shellac parents: diff changeset	80 Retrieves a list of documents that match the specified search
26e78fe6e8c4 "planemo upload commit c699937486c35866861690329de38ec1a5d9f783" shellac parents: diff changeset	81 criteria. How you specify the search criteria depends on which
26e78fe6e8c4 "planemo upload commit c699937486c35866861690329de38ec1a5d9f783" shellac parents: diff changeset	82 query parser you use. Amazon CloudSearch supports four query
26e78fe6e8c4 "planemo upload commit c699937486c35866861690329de38ec1a5d9f783" shellac parents: diff changeset	83 parsers:
26e78fe6e8c4 "planemo upload commit c699937486c35866861690329de38ec1a5d9f783" shellac parents: diff changeset	84
26e78fe6e8c4 "planemo upload commit c699937486c35866861690329de38ec1a5d9f783" shellac parents: diff changeset	85
26e78fe6e8c4 "planemo upload commit c699937486c35866861690329de38ec1a5d9f783" shellac parents: diff changeset	86 + `simple`: search all `text` and `text-array` fields for the
26e78fe6e8c4 "planemo upload commit c699937486c35866861690329de38ec1a5d9f783" shellac parents: diff changeset	87 specified string. Search for phrases, individual terms, and
26e78fe6e8c4 "planemo upload commit c699937486c35866861690329de38ec1a5d9f783" shellac parents: diff changeset	88 prefixes.
26e78fe6e8c4 "planemo upload commit c699937486c35866861690329de38ec1a5d9f783" shellac parents: diff changeset	89 + `structured`: search specific fields, construct compound
26e78fe6e8c4 "planemo upload commit c699937486c35866861690329de38ec1a5d9f783" shellac parents: diff changeset	90 queries using Boolean operators, and use advanced features
26e78fe6e8c4 "planemo upload commit c699937486c35866861690329de38ec1a5d9f783" shellac parents: diff changeset	91 such as term boosting and proximity searching.
26e78fe6e8c4 "planemo upload commit c699937486c35866861690329de38ec1a5d9f783" shellac parents: diff changeset	92 + `lucene`: specify search criteria using the Apache Lucene
26e78fe6e8c4 "planemo upload commit c699937486c35866861690329de38ec1a5d9f783" shellac parents: diff changeset	93 query parser syntax.
26e78fe6e8c4 "planemo upload commit c699937486c35866861690329de38ec1a5d9f783" shellac parents: diff changeset	94 + `dismax`: specify search criteria using the simplified
26e78fe6e8c4 "planemo upload commit c699937486c35866861690329de38ec1a5d9f783" shellac parents: diff changeset	95 subset of the Apache Lucene query parser syntax defined by the
26e78fe6e8c4 "planemo upload commit c699937486c35866861690329de38ec1a5d9f783" shellac parents: diff changeset	96 DisMax query parser.
26e78fe6e8c4 "planemo upload commit c699937486c35866861690329de38ec1a5d9f783" shellac parents: diff changeset	97
26e78fe6e8c4 "planemo upload commit c699937486c35866861690329de38ec1a5d9f783" shellac parents: diff changeset	98
26e78fe6e8c4 "planemo upload commit c699937486c35866861690329de38ec1a5d9f783" shellac parents: diff changeset	99 For more information, see `Searching Your Data`_ in the Amazon
26e78fe6e8c4 "planemo upload commit c699937486c35866861690329de38ec1a5d9f783" shellac parents: diff changeset	100 CloudSearch Developer Guide .
26e78fe6e8c4 "planemo upload commit c699937486c35866861690329de38ec1a5d9f783" shellac parents: diff changeset	101
26e78fe6e8c4 "planemo upload commit c699937486c35866861690329de38ec1a5d9f783" shellac parents: diff changeset	102 The endpoint for submitting `Search` requests is domain-
26e78fe6e8c4 "planemo upload commit c699937486c35866861690329de38ec1a5d9f783" shellac parents: diff changeset	103 specific. You submit search requests to a domain's search
26e78fe6e8c4 "planemo upload commit c699937486c35866861690329de38ec1a5d9f783" shellac parents: diff changeset	104 endpoint. To get the search endpoint for your domain, use the
26e78fe6e8c4 "planemo upload commit c699937486c35866861690329de38ec1a5d9f783" shellac parents: diff changeset	105 Amazon CloudSearch configuration service `DescribeDomains`
26e78fe6e8c4 "planemo upload commit c699937486c35866861690329de38ec1a5d9f783" shellac parents: diff changeset	106 action. A domain's endpoints are also displayed on the domain
26e78fe6e8c4 "planemo upload commit c699937486c35866861690329de38ec1a5d9f783" shellac parents: diff changeset	107 dashboard in the Amazon CloudSearch console.
26e78fe6e8c4 "planemo upload commit c699937486c35866861690329de38ec1a5d9f783" shellac parents: diff changeset	108
26e78fe6e8c4 "planemo upload commit c699937486c35866861690329de38ec1a5d9f783" shellac parents: diff changeset	109 :type cursor: string
26e78fe6e8c4 "planemo upload commit c699937486c35866861690329de38ec1a5d9f783" shellac parents: diff changeset	110 :param cursor: Retrieves a cursor value you can use to page through
26e78fe6e8c4 "planemo upload commit c699937486c35866861690329de38ec1a5d9f783" shellac parents: diff changeset	111 large result sets. Use the `size` parameter to control the number
26e78fe6e8c4 "planemo upload commit c699937486c35866861690329de38ec1a5d9f783" shellac parents: diff changeset	112 of hits to include in each response. You can specify either the
26e78fe6e8c4 "planemo upload commit c699937486c35866861690329de38ec1a5d9f783" shellac parents: diff changeset	113 `cursor` or `start` parameter in a request; they are mutually
26e78fe6e8c4 "planemo upload commit c699937486c35866861690329de38ec1a5d9f783" shellac parents: diff changeset	114 exclusive. To get the first cursor, set the cursor value to
26e78fe6e8c4 "planemo upload commit c699937486c35866861690329de38ec1a5d9f783" shellac parents: diff changeset	115 `initial`. In subsequent requests, specify the cursor value
26e78fe6e8c4 "planemo upload commit c699937486c35866861690329de38ec1a5d9f783" shellac parents: diff changeset	116 returned in the hits section of the response.
26e78fe6e8c4 "planemo upload commit c699937486c35866861690329de38ec1a5d9f783" shellac parents: diff changeset	117 For more information, see `Paginating Results`_ in the Amazon
26e78fe6e8c4 "planemo upload commit c699937486c35866861690329de38ec1a5d9f783" shellac parents: diff changeset	118 CloudSearch Developer Guide .
26e78fe6e8c4 "planemo upload commit c699937486c35866861690329de38ec1a5d9f783" shellac parents: diff changeset	119
26e78fe6e8c4 "planemo upload commit c699937486c35866861690329de38ec1a5d9f783" shellac parents: diff changeset	120 :type expr: string
26e78fe6e8c4 "planemo upload commit c699937486c35866861690329de38ec1a5d9f783" shellac parents: diff changeset	121 :param expr: Defines one or more numeric expressions that can be used
26e78fe6e8c4 "planemo upload commit c699937486c35866861690329de38ec1a5d9f783" shellac parents: diff changeset	122 to sort results or specify search or filter criteria. You can also
26e78fe6e8c4 "planemo upload commit c699937486c35866861690329de38ec1a5d9f783" shellac parents: diff changeset	123 specify expressions as return fields.
26e78fe6e8c4 "planemo upload commit c699937486c35866861690329de38ec1a5d9f783" shellac parents: diff changeset	124 For more information about defining and using expressions, see
26e78fe6e8c4 "planemo upload commit c699937486c35866861690329de38ec1a5d9f783" shellac parents: diff changeset	125 `Configuring Expressions`_ in the Amazon CloudSearch Developer
26e78fe6e8c4 "planemo upload commit c699937486c35866861690329de38ec1a5d9f783" shellac parents: diff changeset	126 Guide .
26e78fe6e8c4 "planemo upload commit c699937486c35866861690329de38ec1a5d9f783" shellac parents: diff changeset	127
26e78fe6e8c4 "planemo upload commit c699937486c35866861690329de38ec1a5d9f783" shellac parents: diff changeset	128 :type facet: string
26e78fe6e8c4 "planemo upload commit c699937486c35866861690329de38ec1a5d9f783" shellac parents: diff changeset	129 :param facet: Specifies one or more fields for which to get facet
26e78fe6e8c4 "planemo upload commit c699937486c35866861690329de38ec1a5d9f783" shellac parents: diff changeset	130 information, and options that control how the facet information is
26e78fe6e8c4 "planemo upload commit c699937486c35866861690329de38ec1a5d9f783" shellac parents: diff changeset	131 returned. Each specified field must be facet-enabled in the domain
26e78fe6e8c4 "planemo upload commit c699937486c35866861690329de38ec1a5d9f783" shellac parents: diff changeset	132 configuration. The fields and options are specified in JSON using
26e78fe6e8c4 "planemo upload commit c699937486c35866861690329de38ec1a5d9f783" shellac parents: diff changeset	133 the form `{"FIELD":{"OPTION":VALUE,"OPTION:"STRING"},"FIELD":{"OPTI
26e78fe6e8c4 "planemo upload commit c699937486c35866861690329de38ec1a5d9f783" shellac parents: diff changeset	134 ON":VALUE,"OPTION":"STRING"}}`.
26e78fe6e8c4 "planemo upload commit c699937486c35866861690329de38ec1a5d9f783" shellac parents: diff changeset	135 You can specify the following faceting options:
26e78fe6e8c4 "planemo upload commit c699937486c35866861690329de38ec1a5d9f783" shellac parents: diff changeset	136
26e78fe6e8c4 "planemo upload commit c699937486c35866861690329de38ec1a5d9f783" shellac parents: diff changeset	137
26e78fe6e8c4 "planemo upload commit c699937486c35866861690329de38ec1a5d9f783" shellac parents: diff changeset	138 + `buckets` specifies an array of the facet values or ranges to count.
26e78fe6e8c4 "planemo upload commit c699937486c35866861690329de38ec1a5d9f783" shellac parents: diff changeset	139 Ranges are specified using the same syntax that you use to search
26e78fe6e8c4 "planemo upload commit c699937486c35866861690329de38ec1a5d9f783" shellac parents: diff changeset	140 for a range of values. For more information, see ` Searching for a
26e78fe6e8c4 "planemo upload commit c699937486c35866861690329de38ec1a5d9f783" shellac parents: diff changeset	141 Range of Values`_ in the Amazon CloudSearch Developer Guide .
26e78fe6e8c4 "planemo upload commit c699937486c35866861690329de38ec1a5d9f783" shellac parents: diff changeset	142 Buckets are returned in the order they are specified in the
26e78fe6e8c4 "planemo upload commit c699937486c35866861690329de38ec1a5d9f783" shellac parents: diff changeset	143 request. The `sort` and `size` options are not valid if you specify
26e78fe6e8c4 "planemo upload commit c699937486c35866861690329de38ec1a5d9f783" shellac parents: diff changeset	144 `buckets`.
26e78fe6e8c4 "planemo upload commit c699937486c35866861690329de38ec1a5d9f783" shellac parents: diff changeset	145 + `size` specifies the maximum number of facets to include in the
26e78fe6e8c4 "planemo upload commit c699937486c35866861690329de38ec1a5d9f783" shellac parents: diff changeset	146 results. By default, Amazon CloudSearch returns counts for the top
26e78fe6e8c4 "planemo upload commit c699937486c35866861690329de38ec1a5d9f783" shellac parents: diff changeset	147 10. The `size` parameter is only valid when you specify the `sort`
26e78fe6e8c4 "planemo upload commit c699937486c35866861690329de38ec1a5d9f783" shellac parents: diff changeset	148 option; it cannot be used in conjunction with `buckets`.
26e78fe6e8c4 "planemo upload commit c699937486c35866861690329de38ec1a5d9f783" shellac parents: diff changeset	149 + `sort` specifies how you want to sort the facets in the results:
26e78fe6e8c4 "planemo upload commit c699937486c35866861690329de38ec1a5d9f783" shellac parents: diff changeset	150 `bucket` or `count`. Specify `bucket` to sort alphabetically or
26e78fe6e8c4 "planemo upload commit c699937486c35866861690329de38ec1a5d9f783" shellac parents: diff changeset	151 numerically by facet value (in ascending order). Specify `count` to
26e78fe6e8c4 "planemo upload commit c699937486c35866861690329de38ec1a5d9f783" shellac parents: diff changeset	152 sort by the facet counts computed for each facet value (in
26e78fe6e8c4 "planemo upload commit c699937486c35866861690329de38ec1a5d9f783" shellac parents: diff changeset	153 descending order). To retrieve facet counts for particular values
26e78fe6e8c4 "planemo upload commit c699937486c35866861690329de38ec1a5d9f783" shellac parents: diff changeset	154 or ranges of values, use the `buckets` option instead of `sort`.
26e78fe6e8c4 "planemo upload commit c699937486c35866861690329de38ec1a5d9f783" shellac parents: diff changeset	155
26e78fe6e8c4 "planemo upload commit c699937486c35866861690329de38ec1a5d9f783" shellac parents: diff changeset	156
26e78fe6e8c4 "planemo upload commit c699937486c35866861690329de38ec1a5d9f783" shellac parents: diff changeset	157 If no facet options are specified, facet counts are computed for all
26e78fe6e8c4 "planemo upload commit c699937486c35866861690329de38ec1a5d9f783" shellac parents: diff changeset	158 field values, the facets are sorted by facet count, and the top 10
26e78fe6e8c4 "planemo upload commit c699937486c35866861690329de38ec1a5d9f783" shellac parents: diff changeset	159 facets are returned in the results.
26e78fe6e8c4 "planemo upload commit c699937486c35866861690329de38ec1a5d9f783" shellac parents: diff changeset	160
26e78fe6e8c4 "planemo upload commit c699937486c35866861690329de38ec1a5d9f783" shellac parents: diff changeset	161 For more information, see `Getting and Using Facet Information`_ in the
26e78fe6e8c4 "planemo upload commit c699937486c35866861690329de38ec1a5d9f783" shellac parents: diff changeset	162 Amazon CloudSearch Developer Guide .
26e78fe6e8c4 "planemo upload commit c699937486c35866861690329de38ec1a5d9f783" shellac parents: diff changeset	163
26e78fe6e8c4 "planemo upload commit c699937486c35866861690329de38ec1a5d9f783" shellac parents: diff changeset	164 :type filter_query: string
26e78fe6e8c4 "planemo upload commit c699937486c35866861690329de38ec1a5d9f783" shellac parents: diff changeset	165 :param filter_query: Specifies a structured query that filters the
26e78fe6e8c4 "planemo upload commit c699937486c35866861690329de38ec1a5d9f783" shellac parents: diff changeset	166 results of a search without affecting how the results are scored
26e78fe6e8c4 "planemo upload commit c699937486c35866861690329de38ec1a5d9f783" shellac parents: diff changeset	167 and sorted. You use `filterQuery` in conjunction with the `query`
26e78fe6e8c4 "planemo upload commit c699937486c35866861690329de38ec1a5d9f783" shellac parents: diff changeset	168 parameter to filter the documents that match the constraints
26e78fe6e8c4 "planemo upload commit c699937486c35866861690329de38ec1a5d9f783" shellac parents: diff changeset	169 specified in the `query` parameter. Specifying a filter controls
26e78fe6e8c4 "planemo upload commit c699937486c35866861690329de38ec1a5d9f783" shellac parents: diff changeset	170 only which matching documents are included in the results, it has
26e78fe6e8c4 "planemo upload commit c699937486c35866861690329de38ec1a5d9f783" shellac parents: diff changeset	171 no effect on how they are scored and sorted. The `filterQuery`
26e78fe6e8c4 "planemo upload commit c699937486c35866861690329de38ec1a5d9f783" shellac parents: diff changeset	172 parameter supports the full structured query syntax.
26e78fe6e8c4 "planemo upload commit c699937486c35866861690329de38ec1a5d9f783" shellac parents: diff changeset	173 For more information about using filters, see `Filtering Matching
26e78fe6e8c4 "planemo upload commit c699937486c35866861690329de38ec1a5d9f783" shellac parents: diff changeset	174 Documents`_ in the Amazon CloudSearch Developer Guide .
26e78fe6e8c4 "planemo upload commit c699937486c35866861690329de38ec1a5d9f783" shellac parents: diff changeset	175
26e78fe6e8c4 "planemo upload commit c699937486c35866861690329de38ec1a5d9f783" shellac parents: diff changeset	176 :type highlight: string
26e78fe6e8c4 "planemo upload commit c699937486c35866861690329de38ec1a5d9f783" shellac parents: diff changeset	177 :param highlight: Retrieves highlights for matches in the specified
26e78fe6e8c4 "planemo upload commit c699937486c35866861690329de38ec1a5d9f783" shellac parents: diff changeset	178 `text` or `text-array` fields. Each specified field must be
26e78fe6e8c4 "planemo upload commit c699937486c35866861690329de38ec1a5d9f783" shellac parents: diff changeset	179 highlight enabled in the domain configuration. The fields and
26e78fe6e8c4 "planemo upload commit c699937486c35866861690329de38ec1a5d9f783" shellac parents: diff changeset	180 options are specified in JSON using the form `{"FIELD":{"OPTION":VA
26e78fe6e8c4 "planemo upload commit c699937486c35866861690329de38ec1a5d9f783" shellac parents: diff changeset	181 LUE,"OPTION:"STRING"},"FIELD":{"OPTION":VALUE,"OPTION":"STRING"}}`.
26e78fe6e8c4 "planemo upload commit c699937486c35866861690329de38ec1a5d9f783" shellac parents: diff changeset	182 You can specify the following highlight options:
26e78fe6e8c4 "planemo upload commit c699937486c35866861690329de38ec1a5d9f783" shellac parents: diff changeset	183
26e78fe6e8c4 "planemo upload commit c699937486c35866861690329de38ec1a5d9f783" shellac parents: diff changeset	184
26e78fe6e8c4 "planemo upload commit c699937486c35866861690329de38ec1a5d9f783" shellac parents: diff changeset	185 + `format`: specifies the format of the data in the text field: `text`
26e78fe6e8c4 "planemo upload commit c699937486c35866861690329de38ec1a5d9f783" shellac parents: diff changeset	186 or `html`. When data is returned as HTML, all non-alphanumeric
26e78fe6e8c4 "planemo upload commit c699937486c35866861690329de38ec1a5d9f783" shellac parents: diff changeset	187 characters are encoded. The default is `html`.
26e78fe6e8c4 "planemo upload commit c699937486c35866861690329de38ec1a5d9f783" shellac parents: diff changeset	188 + `max_phrases`: specifies the maximum number of occurrences of the
26e78fe6e8c4 "planemo upload commit c699937486c35866861690329de38ec1a5d9f783" shellac parents: diff changeset	189 search term(s) you want to highlight. By default, the first
26e78fe6e8c4 "planemo upload commit c699937486c35866861690329de38ec1a5d9f783" shellac parents: diff changeset	190 occurrence is highlighted.
26e78fe6e8c4 "planemo upload commit c699937486c35866861690329de38ec1a5d9f783" shellac parents: diff changeset	191 + `pre_tag`: specifies the string to prepend to an occurrence of a
26e78fe6e8c4 "planemo upload commit c699937486c35866861690329de38ec1a5d9f783" shellac parents: diff changeset	192 search term. The default for HTML highlights is `<em>`. The
26e78fe6e8c4 "planemo upload commit c699937486c35866861690329de38ec1a5d9f783" shellac parents: diff changeset	193 default for text highlights is `*`.
26e78fe6e8c4 "planemo upload commit c699937486c35866861690329de38ec1a5d9f783" shellac parents: diff changeset	194 + `post_tag`: specifies the string to append to an occurrence of a
26e78fe6e8c4 "planemo upload commit c699937486c35866861690329de38ec1a5d9f783" shellac parents: diff changeset	195 search term. The default for HTML highlights is `</em>`. The
26e78fe6e8c4 "planemo upload commit c699937486c35866861690329de38ec1a5d9f783" shellac parents: diff changeset	196 default for text highlights is `*`.
26e78fe6e8c4 "planemo upload commit c699937486c35866861690329de38ec1a5d9f783" shellac parents: diff changeset	197
26e78fe6e8c4 "planemo upload commit c699937486c35866861690329de38ec1a5d9f783" shellac parents: diff changeset	198
26e78fe6e8c4 "planemo upload commit c699937486c35866861690329de38ec1a5d9f783" shellac parents: diff changeset	199 If no highlight options are specified for a field, the returned field
26e78fe6e8c4 "planemo upload commit c699937486c35866861690329de38ec1a5d9f783" shellac parents: diff changeset	200 text is treated as HTML and the first match is highlighted with
26e78fe6e8c4 "planemo upload commit c699937486c35866861690329de38ec1a5d9f783" shellac parents: diff changeset	201 emphasis tags: `<em>search-term</em>`.
26e78fe6e8c4 "planemo upload commit c699937486c35866861690329de38ec1a5d9f783" shellac parents: diff changeset	202
26e78fe6e8c4 "planemo upload commit c699937486c35866861690329de38ec1a5d9f783" shellac parents: diff changeset	203 :type partial: boolean
26e78fe6e8c4 "planemo upload commit c699937486c35866861690329de38ec1a5d9f783" shellac parents: diff changeset	204 :param partial: Enables partial results to be returned if one or more
26e78fe6e8c4 "planemo upload commit c699937486c35866861690329de38ec1a5d9f783" shellac parents: diff changeset	205 index partitions are unavailable. When your search index is
26e78fe6e8c4 "planemo upload commit c699937486c35866861690329de38ec1a5d9f783" shellac parents: diff changeset	206 partitioned across multiple search instances, by default Amazon
26e78fe6e8c4 "planemo upload commit c699937486c35866861690329de38ec1a5d9f783" shellac parents: diff changeset	207 CloudSearch only returns results if every partition can be queried.
26e78fe6e8c4 "planemo upload commit c699937486c35866861690329de38ec1a5d9f783" shellac parents: diff changeset	208 This means that the failure of a single search instance can result
26e78fe6e8c4 "planemo upload commit c699937486c35866861690329de38ec1a5d9f783" shellac parents: diff changeset	209 in 5xx (internal server) errors. When you enable partial results,
26e78fe6e8c4 "planemo upload commit c699937486c35866861690329de38ec1a5d9f783" shellac parents: diff changeset	210 Amazon CloudSearch returns whatever results are available and
26e78fe6e8c4 "planemo upload commit c699937486c35866861690329de38ec1a5d9f783" shellac parents: diff changeset	211 includes the percentage of documents searched in the search results
26e78fe6e8c4 "planemo upload commit c699937486c35866861690329de38ec1a5d9f783" shellac parents: diff changeset	212 (percent-searched). This enables you to more gracefully degrade
26e78fe6e8c4 "planemo upload commit c699937486c35866861690329de38ec1a5d9f783" shellac parents: diff changeset	213 your users' search experience. For example, rather than displaying
26e78fe6e8c4 "planemo upload commit c699937486c35866861690329de38ec1a5d9f783" shellac parents: diff changeset	214 no results, you could display the partial results and a message
26e78fe6e8c4 "planemo upload commit c699937486c35866861690329de38ec1a5d9f783" shellac parents: diff changeset	215 indicating that the results might be incomplete due to a temporary
26e78fe6e8c4 "planemo upload commit c699937486c35866861690329de38ec1a5d9f783" shellac parents: diff changeset	216 system outage.
26e78fe6e8c4 "planemo upload commit c699937486c35866861690329de38ec1a5d9f783" shellac parents: diff changeset	217
26e78fe6e8c4 "planemo upload commit c699937486c35866861690329de38ec1a5d9f783" shellac parents: diff changeset	218 :type query: string
26e78fe6e8c4 "planemo upload commit c699937486c35866861690329de38ec1a5d9f783" shellac parents: diff changeset	219 :param query: Specifies the search criteria for the request. How you
26e78fe6e8c4 "planemo upload commit c699937486c35866861690329de38ec1a5d9f783" shellac parents: diff changeset	220 specify the search criteria depends on the query parser used for
26e78fe6e8c4 "planemo upload commit c699937486c35866861690329de38ec1a5d9f783" shellac parents: diff changeset	221 the request and the parser options specified in the `queryOptions`
26e78fe6e8c4 "planemo upload commit c699937486c35866861690329de38ec1a5d9f783" shellac parents: diff changeset	222 parameter. By default, the `simple` query parser is used to process
26e78fe6e8c4 "planemo upload commit c699937486c35866861690329de38ec1a5d9f783" shellac parents: diff changeset	223 requests. To use the `structured`, `lucene`, or `dismax` query
26e78fe6e8c4 "planemo upload commit c699937486c35866861690329de38ec1a5d9f783" shellac parents: diff changeset	224 parser, you must also specify the `queryParser` parameter.
26e78fe6e8c4 "planemo upload commit c699937486c35866861690329de38ec1a5d9f783" shellac parents: diff changeset	225 For more information about specifying search criteria, see `Searching
26e78fe6e8c4 "planemo upload commit c699937486c35866861690329de38ec1a5d9f783" shellac parents: diff changeset	226 Your Data`_ in the Amazon CloudSearch Developer Guide .
26e78fe6e8c4 "planemo upload commit c699937486c35866861690329de38ec1a5d9f783" shellac parents: diff changeset	227
26e78fe6e8c4 "planemo upload commit c699937486c35866861690329de38ec1a5d9f783" shellac parents: diff changeset	228 :type query_options: string
26e78fe6e8c4 "planemo upload commit c699937486c35866861690329de38ec1a5d9f783" shellac parents: diff changeset	229 :param query_options:
26e78fe6e8c4 "planemo upload commit c699937486c35866861690329de38ec1a5d9f783" shellac parents: diff changeset	230 Configures options for the query parser specified in the `queryParser`
26e78fe6e8c4 "planemo upload commit c699937486c35866861690329de38ec1a5d9f783" shellac parents: diff changeset	231 parameter.
26e78fe6e8c4 "planemo upload commit c699937486c35866861690329de38ec1a5d9f783" shellac parents: diff changeset	232
26e78fe6e8c4 "planemo upload commit c699937486c35866861690329de38ec1a5d9f783" shellac parents: diff changeset	233 The options you can configure vary according to which parser you use:
26e78fe6e8c4 "planemo upload commit c699937486c35866861690329de38ec1a5d9f783" shellac parents: diff changeset	234
26e78fe6e8c4 "planemo upload commit c699937486c35866861690329de38ec1a5d9f783" shellac parents: diff changeset	235
26e78fe6e8c4 "planemo upload commit c699937486c35866861690329de38ec1a5d9f783" shellac parents: diff changeset	236 + `defaultOperator`: The default operator used to combine individual
26e78fe6e8c4 "planemo upload commit c699937486c35866861690329de38ec1a5d9f783" shellac parents: diff changeset	237 terms in the search string. For example: `defaultOperator: 'or'`.
26e78fe6e8c4 "planemo upload commit c699937486c35866861690329de38ec1a5d9f783" shellac parents: diff changeset	238 For the `dismax` parser, you specify a percentage that represents
26e78fe6e8c4 "planemo upload commit c699937486c35866861690329de38ec1a5d9f783" shellac parents: diff changeset	239 the percentage of terms in the search string (rounded down) that
26e78fe6e8c4 "planemo upload commit c699937486c35866861690329de38ec1a5d9f783" shellac parents: diff changeset	240 must match, rather than a default operator. A value of `0%` is the
26e78fe6e8c4 "planemo upload commit c699937486c35866861690329de38ec1a5d9f783" shellac parents: diff changeset	241 equivalent to OR, and a value of `100%` is equivalent to AND. The
26e78fe6e8c4 "planemo upload commit c699937486c35866861690329de38ec1a5d9f783" shellac parents: diff changeset	242 percentage must be specified as a value in the range 0-100 followed
26e78fe6e8c4 "planemo upload commit c699937486c35866861690329de38ec1a5d9f783" shellac parents: diff changeset	243 by the percent (%) symbol. For example, `defaultOperator: 50%`.
26e78fe6e8c4 "planemo upload commit c699937486c35866861690329de38ec1a5d9f783" shellac parents: diff changeset	244 Valid values: `and`, `or`, a percentage in the range 0%-100% (
26e78fe6e8c4 "planemo upload commit c699937486c35866861690329de38ec1a5d9f783" shellac parents: diff changeset	245 `dismax`). Default: `and` ( `simple`, `structured`, `lucene`) or
26e78fe6e8c4 "planemo upload commit c699937486c35866861690329de38ec1a5d9f783" shellac parents: diff changeset	246 `100` ( `dismax`). Valid for: `simple`, `structured`, `lucene`, and
26e78fe6e8c4 "planemo upload commit c699937486c35866861690329de38ec1a5d9f783" shellac parents: diff changeset	247 `dismax`.
26e78fe6e8c4 "planemo upload commit c699937486c35866861690329de38ec1a5d9f783" shellac parents: diff changeset	248 + `fields`: An array of the fields to search when no fields are
26e78fe6e8c4 "planemo upload commit c699937486c35866861690329de38ec1a5d9f783" shellac parents: diff changeset	249 specified in a search. If no fields are specified in a search and
26e78fe6e8c4 "planemo upload commit c699937486c35866861690329de38ec1a5d9f783" shellac parents: diff changeset	250 this option is not specified, all text and text-array fields are
26e78fe6e8c4 "planemo upload commit c699937486c35866861690329de38ec1a5d9f783" shellac parents: diff changeset	251 searched. You can specify a weight for each field to control the
26e78fe6e8c4 "planemo upload commit c699937486c35866861690329de38ec1a5d9f783" shellac parents: diff changeset	252 relative importance of each field when Amazon CloudSearch
26e78fe6e8c4 "planemo upload commit c699937486c35866861690329de38ec1a5d9f783" shellac parents: diff changeset	253 calculates relevance scores. To specify a field weight, append a
26e78fe6e8c4 "planemo upload commit c699937486c35866861690329de38ec1a5d9f783" shellac parents: diff changeset	254 caret ( `^`) symbol and the weight to the field name. For example,
26e78fe6e8c4 "planemo upload commit c699937486c35866861690329de38ec1a5d9f783" shellac parents: diff changeset	255 to boost the importance of the `title` field over the `description`
26e78fe6e8c4 "planemo upload commit c699937486c35866861690329de38ec1a5d9f783" shellac parents: diff changeset	256 field you could specify: `"fields":["title^5","description"]`.
26e78fe6e8c4 "planemo upload commit c699937486c35866861690329de38ec1a5d9f783" shellac parents: diff changeset	257 Valid values: The name of any configured field and an optional
26e78fe6e8c4 "planemo upload commit c699937486c35866861690329de38ec1a5d9f783" shellac parents: diff changeset	258 numeric value greater than zero. Default: All `text` and `text-
26e78fe6e8c4 "planemo upload commit c699937486c35866861690329de38ec1a5d9f783" shellac parents: diff changeset	259 array` fields. Valid for: `simple`, `structured`, `lucene`, and
26e78fe6e8c4 "planemo upload commit c699937486c35866861690329de38ec1a5d9f783" shellac parents: diff changeset	260 `dismax`.
26e78fe6e8c4 "planemo upload commit c699937486c35866861690329de38ec1a5d9f783" shellac parents: diff changeset	261 + `operators`: An array of the operators or special characters you want
26e78fe6e8c4 "planemo upload commit c699937486c35866861690329de38ec1a5d9f783" shellac parents: diff changeset	262 to disable for the simple query parser. If you disable the `and`,
26e78fe6e8c4 "planemo upload commit c699937486c35866861690329de38ec1a5d9f783" shellac parents: diff changeset	263 `or`, or `not` operators, the corresponding operators ( `+`, `\|`,
26e78fe6e8c4 "planemo upload commit c699937486c35866861690329de38ec1a5d9f783" shellac parents: diff changeset	264 `-`) have no special meaning and are dropped from the search
26e78fe6e8c4 "planemo upload commit c699937486c35866861690329de38ec1a5d9f783" shellac parents: diff changeset	265 string. Similarly, disabling `prefix` disables the wildcard
26e78fe6e8c4 "planemo upload commit c699937486c35866861690329de38ec1a5d9f783" shellac parents: diff changeset	266 operator ( `*`) and disabling `phrase` disables the ability to
26e78fe6e8c4 "planemo upload commit c699937486c35866861690329de38ec1a5d9f783" shellac parents: diff changeset	267 search for phrases by enclosing phrases in double quotes. Disabling
26e78fe6e8c4 "planemo upload commit c699937486c35866861690329de38ec1a5d9f783" shellac parents: diff changeset	268 precedence disables the ability to control order of precedence
26e78fe6e8c4 "planemo upload commit c699937486c35866861690329de38ec1a5d9f783" shellac parents: diff changeset	269 using parentheses. Disabling `near` disables the ability to use the
26e78fe6e8c4 "planemo upload commit c699937486c35866861690329de38ec1a5d9f783" shellac parents: diff changeset	270 ~ operator to perform a sloppy phrase search. Disabling the `fuzzy`
26e78fe6e8c4 "planemo upload commit c699937486c35866861690329de38ec1a5d9f783" shellac parents: diff changeset	271 operator disables the ability to use the ~ operator to perform a
26e78fe6e8c4 "planemo upload commit c699937486c35866861690329de38ec1a5d9f783" shellac parents: diff changeset	272 fuzzy search. `escape` disables the ability to use a backslash (
26e78fe6e8c4 "planemo upload commit c699937486c35866861690329de38ec1a5d9f783" shellac parents: diff changeset	273 `\`) to escape special characters within the search string.
26e78fe6e8c4 "planemo upload commit c699937486c35866861690329de38ec1a5d9f783" shellac parents: diff changeset	274 Disabling whitespace is an advanced option that prevents the parser
26e78fe6e8c4 "planemo upload commit c699937486c35866861690329de38ec1a5d9f783" shellac parents: diff changeset	275 from tokenizing on whitespace, which can be useful for Vietnamese.
26e78fe6e8c4 "planemo upload commit c699937486c35866861690329de38ec1a5d9f783" shellac parents: diff changeset	276 (It prevents Vietnamese words from being split incorrectly.) For
26e78fe6e8c4 "planemo upload commit c699937486c35866861690329de38ec1a5d9f783" shellac parents: diff changeset	277 example, you could disable all operators other than the phrase
26e78fe6e8c4 "planemo upload commit c699937486c35866861690329de38ec1a5d9f783" shellac parents: diff changeset	278 operator to support just simple term and phrase queries:
26e78fe6e8c4 "planemo upload commit c699937486c35866861690329de38ec1a5d9f783" shellac parents: diff changeset	279 `"operators":["and","not","or", "prefix"]`. Valid values: `and`,
26e78fe6e8c4 "planemo upload commit c699937486c35866861690329de38ec1a5d9f783" shellac parents: diff changeset	280 `escape`, `fuzzy`, `near`, `not`, `or`, `phrase`, `precedence`,
26e78fe6e8c4 "planemo upload commit c699937486c35866861690329de38ec1a5d9f783" shellac parents: diff changeset	281 `prefix`, `whitespace`. Default: All operators and special
26e78fe6e8c4 "planemo upload commit c699937486c35866861690329de38ec1a5d9f783" shellac parents: diff changeset	282 characters are enabled. Valid for: `simple`.
26e78fe6e8c4 "planemo upload commit c699937486c35866861690329de38ec1a5d9f783" shellac parents: diff changeset	283 + `phraseFields`: An array of the `text` or `text-array` fields you
26e78fe6e8c4 "planemo upload commit c699937486c35866861690329de38ec1a5d9f783" shellac parents: diff changeset	284 want to use for phrase searches. When the terms in the search
26e78fe6e8c4 "planemo upload commit c699937486c35866861690329de38ec1a5d9f783" shellac parents: diff changeset	285 string appear in close proximity within a field, the field scores
26e78fe6e8c4 "planemo upload commit c699937486c35866861690329de38ec1a5d9f783" shellac parents: diff changeset	286 higher. You can specify a weight for each field to boost that
26e78fe6e8c4 "planemo upload commit c699937486c35866861690329de38ec1a5d9f783" shellac parents: diff changeset	287 score. The `phraseSlop` option controls how much the matches can
26e78fe6e8c4 "planemo upload commit c699937486c35866861690329de38ec1a5d9f783" shellac parents: diff changeset	288 deviate from the search string and still be boosted. To specify a
26e78fe6e8c4 "planemo upload commit c699937486c35866861690329de38ec1a5d9f783" shellac parents: diff changeset	289 field weight, append a caret ( `^`) symbol and the weight to the
26e78fe6e8c4 "planemo upload commit c699937486c35866861690329de38ec1a5d9f783" shellac parents: diff changeset	290 field name. For example, to boost phrase matches in the `title`
26e78fe6e8c4 "planemo upload commit c699937486c35866861690329de38ec1a5d9f783" shellac parents: diff changeset	291 field over the `abstract` field, you could specify:
26e78fe6e8c4 "planemo upload commit c699937486c35866861690329de38ec1a5d9f783" shellac parents: diff changeset	292 `"phraseFields":["title^3", "plot"]` Valid values: The name of any
26e78fe6e8c4 "planemo upload commit c699937486c35866861690329de38ec1a5d9f783" shellac parents: diff changeset	293 `text` or `text-array` field and an optional numeric value greater
26e78fe6e8c4 "planemo upload commit c699937486c35866861690329de38ec1a5d9f783" shellac parents: diff changeset	294 than zero. Default: No fields. If you don't specify any fields with
26e78fe6e8c4 "planemo upload commit c699937486c35866861690329de38ec1a5d9f783" shellac parents: diff changeset	295 `phraseFields`, proximity scoring is disabled even if `phraseSlop`
26e78fe6e8c4 "planemo upload commit c699937486c35866861690329de38ec1a5d9f783" shellac parents: diff changeset	296 is specified. Valid for: `dismax`.
26e78fe6e8c4 "planemo upload commit c699937486c35866861690329de38ec1a5d9f783" shellac parents: diff changeset	297 + `phraseSlop`: An integer value that specifies how much matches can
26e78fe6e8c4 "planemo upload commit c699937486c35866861690329de38ec1a5d9f783" shellac parents: diff changeset	298 deviate from the search phrase and still be boosted according to
26e78fe6e8c4 "planemo upload commit c699937486c35866861690329de38ec1a5d9f783" shellac parents: diff changeset	299 the weights specified in the `phraseFields` option; for example,
26e78fe6e8c4 "planemo upload commit c699937486c35866861690329de38ec1a5d9f783" shellac parents: diff changeset	300 `phraseSlop: 2`. You must also specify `phraseFields` to enable
26e78fe6e8c4 "planemo upload commit c699937486c35866861690329de38ec1a5d9f783" shellac parents: diff changeset	301 proximity scoring. Valid values: positive integers. Default: 0.
26e78fe6e8c4 "planemo upload commit c699937486c35866861690329de38ec1a5d9f783" shellac parents: diff changeset	302 Valid for: `dismax`.
26e78fe6e8c4 "planemo upload commit c699937486c35866861690329de38ec1a5d9f783" shellac parents: diff changeset	303 + `explicitPhraseSlop`: An integer value that specifies how much a
26e78fe6e8c4 "planemo upload commit c699937486c35866861690329de38ec1a5d9f783" shellac parents: diff changeset	304 match can deviate from the search phrase when the phrase is
26e78fe6e8c4 "planemo upload commit c699937486c35866861690329de38ec1a5d9f783" shellac parents: diff changeset	305 enclosed in double quotes in the search string. (Phrases that
26e78fe6e8c4 "planemo upload commit c699937486c35866861690329de38ec1a5d9f783" shellac parents: diff changeset	306 exceed this proximity distance are not considered a match.) For
26e78fe6e8c4 "planemo upload commit c699937486c35866861690329de38ec1a5d9f783" shellac parents: diff changeset	307 example, to specify a slop of three for dismax phrase queries, you
26e78fe6e8c4 "planemo upload commit c699937486c35866861690329de38ec1a5d9f783" shellac parents: diff changeset	308 would specify `"explicitPhraseSlop":3`. Valid values: positive
26e78fe6e8c4 "planemo upload commit c699937486c35866861690329de38ec1a5d9f783" shellac parents: diff changeset	309 integers. Default: 0. Valid for: `dismax`.
26e78fe6e8c4 "planemo upload commit c699937486c35866861690329de38ec1a5d9f783" shellac parents: diff changeset	310 + `tieBreaker`: When a term in the search string is found in a
26e78fe6e8c4 "planemo upload commit c699937486c35866861690329de38ec1a5d9f783" shellac parents: diff changeset	311 document's field, a score is calculated for that field based on how
26e78fe6e8c4 "planemo upload commit c699937486c35866861690329de38ec1a5d9f783" shellac parents: diff changeset	312 common the word is in that field compared to other documents. If
26e78fe6e8c4 "planemo upload commit c699937486c35866861690329de38ec1a5d9f783" shellac parents: diff changeset	313 the term occurs in multiple fields within a document, by default
26e78fe6e8c4 "planemo upload commit c699937486c35866861690329de38ec1a5d9f783" shellac parents: diff changeset	314 only the highest scoring field contributes to the document's
26e78fe6e8c4 "planemo upload commit c699937486c35866861690329de38ec1a5d9f783" shellac parents: diff changeset	315 overall score. You can specify a `tieBreaker` value to enable the
26e78fe6e8c4 "planemo upload commit c699937486c35866861690329de38ec1a5d9f783" shellac parents: diff changeset	316 matches in lower-scoring fields to contribute to the document's
26e78fe6e8c4 "planemo upload commit c699937486c35866861690329de38ec1a5d9f783" shellac parents: diff changeset	317 score. That way, if two documents have the same max field score for
26e78fe6e8c4 "planemo upload commit c699937486c35866861690329de38ec1a5d9f783" shellac parents: diff changeset	318 a particular term, the score for the document that has matches in
26e78fe6e8c4 "planemo upload commit c699937486c35866861690329de38ec1a5d9f783" shellac parents: diff changeset	319 more fields will be higher. The formula for calculating the score
26e78fe6e8c4 "planemo upload commit c699937486c35866861690329de38ec1a5d9f783" shellac parents: diff changeset	320 with a tieBreaker is `(max field score) + (tieBreaker) * (sum of
26e78fe6e8c4 "planemo upload commit c699937486c35866861690329de38ec1a5d9f783" shellac parents: diff changeset	321 the scores for the rest of the matching fields)`. Set `tieBreaker`
26e78fe6e8c4 "planemo upload commit c699937486c35866861690329de38ec1a5d9f783" shellac parents: diff changeset	322 to 0 to disregard all but the highest scoring field (pure max):
26e78fe6e8c4 "planemo upload commit c699937486c35866861690329de38ec1a5d9f783" shellac parents: diff changeset	323 `"tieBreaker":0`. Set to 1 to sum the scores from all fields (pure
26e78fe6e8c4 "planemo upload commit c699937486c35866861690329de38ec1a5d9f783" shellac parents: diff changeset	324 sum): `"tieBreaker":1`. Valid values: 0.0 to 1.0. Default: 0.0.
26e78fe6e8c4 "planemo upload commit c699937486c35866861690329de38ec1a5d9f783" shellac parents: diff changeset	325 Valid for: `dismax`.
26e78fe6e8c4 "planemo upload commit c699937486c35866861690329de38ec1a5d9f783" shellac parents: diff changeset	326
26e78fe6e8c4 "planemo upload commit c699937486c35866861690329de38ec1a5d9f783" shellac parents: diff changeset	327 :type query_parser: string
26e78fe6e8c4 "planemo upload commit c699937486c35866861690329de38ec1a5d9f783" shellac parents: diff changeset	328 :param query_parser:
26e78fe6e8c4 "planemo upload commit c699937486c35866861690329de38ec1a5d9f783" shellac parents: diff changeset	329 Specifies which query parser to use to process the request. If
26e78fe6e8c4 "planemo upload commit c699937486c35866861690329de38ec1a5d9f783" shellac parents: diff changeset	330 `queryParser` is not specified, Amazon CloudSearch uses the
26e78fe6e8c4 "planemo upload commit c699937486c35866861690329de38ec1a5d9f783" shellac parents: diff changeset	331 `simple` query parser.
26e78fe6e8c4 "planemo upload commit c699937486c35866861690329de38ec1a5d9f783" shellac parents: diff changeset	332
26e78fe6e8c4 "planemo upload commit c699937486c35866861690329de38ec1a5d9f783" shellac parents: diff changeset	333 Amazon CloudSearch supports four query parsers:
26e78fe6e8c4 "planemo upload commit c699937486c35866861690329de38ec1a5d9f783" shellac parents: diff changeset	334
26e78fe6e8c4 "planemo upload commit c699937486c35866861690329de38ec1a5d9f783" shellac parents: diff changeset	335
26e78fe6e8c4 "planemo upload commit c699937486c35866861690329de38ec1a5d9f783" shellac parents: diff changeset	336 + `simple`: perform simple searches of `text` and `text-array` fields.
26e78fe6e8c4 "planemo upload commit c699937486c35866861690329de38ec1a5d9f783" shellac parents: diff changeset	337 By default, the `simple` query parser searches all `text` and
26e78fe6e8c4 "planemo upload commit c699937486c35866861690329de38ec1a5d9f783" shellac parents: diff changeset	338 `text-array` fields. You can specify which fields to search by with
26e78fe6e8c4 "planemo upload commit c699937486c35866861690329de38ec1a5d9f783" shellac parents: diff changeset	339 the `queryOptions` parameter. If you prefix a search term with a
26e78fe6e8c4 "planemo upload commit c699937486c35866861690329de38ec1a5d9f783" shellac parents: diff changeset	340 plus sign (+) documents must contain the term to be considered a
26e78fe6e8c4 "planemo upload commit c699937486c35866861690329de38ec1a5d9f783" shellac parents: diff changeset	341 match. (This is the default, unless you configure the default
26e78fe6e8c4 "planemo upload commit c699937486c35866861690329de38ec1a5d9f783" shellac parents: diff changeset	342 operator with the `queryOptions` parameter.) You can use the `-`
26e78fe6e8c4 "planemo upload commit c699937486c35866861690329de38ec1a5d9f783" shellac parents: diff changeset	343 (NOT), `\|` (OR), and `*` (wildcard) operators to exclude particular
26e78fe6e8c4 "planemo upload commit c699937486c35866861690329de38ec1a5d9f783" shellac parents: diff changeset	344 terms, find results that match any of the specified terms, or
26e78fe6e8c4 "planemo upload commit c699937486c35866861690329de38ec1a5d9f783" shellac parents: diff changeset	345 search for a prefix. To search for a phrase rather than individual
26e78fe6e8c4 "planemo upload commit c699937486c35866861690329de38ec1a5d9f783" shellac parents: diff changeset	346 terms, enclose the phrase in double quotes. For more information,
26e78fe6e8c4 "planemo upload commit c699937486c35866861690329de38ec1a5d9f783" shellac parents: diff changeset	347 see `Searching for Text`_ in the Amazon CloudSearch Developer Guide
26e78fe6e8c4 "planemo upload commit c699937486c35866861690329de38ec1a5d9f783" shellac parents: diff changeset	348 .
26e78fe6e8c4 "planemo upload commit c699937486c35866861690329de38ec1a5d9f783" shellac parents: diff changeset	349 + `structured`: perform advanced searches by combining multiple
26e78fe6e8c4 "planemo upload commit c699937486c35866861690329de38ec1a5d9f783" shellac parents: diff changeset	350 expressions to define the search criteria. You can also search
26e78fe6e8c4 "planemo upload commit c699937486c35866861690329de38ec1a5d9f783" shellac parents: diff changeset	351 within particular fields, search for values and ranges of values,
26e78fe6e8c4 "planemo upload commit c699937486c35866861690329de38ec1a5d9f783" shellac parents: diff changeset	352 and use advanced options such as term boosting, `matchall`, and
26e78fe6e8c4 "planemo upload commit c699937486c35866861690329de38ec1a5d9f783" shellac parents: diff changeset	353 `near`. For more information, see `Constructing Compound Queries`_
26e78fe6e8c4 "planemo upload commit c699937486c35866861690329de38ec1a5d9f783" shellac parents: diff changeset	354 in the Amazon CloudSearch Developer Guide .
26e78fe6e8c4 "planemo upload commit c699937486c35866861690329de38ec1a5d9f783" shellac parents: diff changeset	355 + `lucene`: search using the Apache Lucene query parser syntax. For
26e78fe6e8c4 "planemo upload commit c699937486c35866861690329de38ec1a5d9f783" shellac parents: diff changeset	356 more information, see `Apache Lucene Query Parser Syntax`_.
26e78fe6e8c4 "planemo upload commit c699937486c35866861690329de38ec1a5d9f783" shellac parents: diff changeset	357 + `dismax`: search using the simplified subset of the Apache Lucene
26e78fe6e8c4 "planemo upload commit c699937486c35866861690329de38ec1a5d9f783" shellac parents: diff changeset	358 query parser syntax defined by the DisMax query parser. For more
26e78fe6e8c4 "planemo upload commit c699937486c35866861690329de38ec1a5d9f783" shellac parents: diff changeset	359 information, see `DisMax Query Parser Syntax`_.
26e78fe6e8c4 "planemo upload commit c699937486c35866861690329de38ec1a5d9f783" shellac parents: diff changeset	360
26e78fe6e8c4 "planemo upload commit c699937486c35866861690329de38ec1a5d9f783" shellac parents: diff changeset	361 :type ret: string
26e78fe6e8c4 "planemo upload commit c699937486c35866861690329de38ec1a5d9f783" shellac parents: diff changeset	362 :param ret: Specifies the field and expression values to include in
26e78fe6e8c4 "planemo upload commit c699937486c35866861690329de38ec1a5d9f783" shellac parents: diff changeset	363 the response. Multiple fields or expressions are specified as a
26e78fe6e8c4 "planemo upload commit c699937486c35866861690329de38ec1a5d9f783" shellac parents: diff changeset	364 comma-separated list. By default, a search response includes all
26e78fe6e8c4 "planemo upload commit c699937486c35866861690329de38ec1a5d9f783" shellac parents: diff changeset	365 return enabled fields ( `_all_fields`). To return only the document
26e78fe6e8c4 "planemo upload commit c699937486c35866861690329de38ec1a5d9f783" shellac parents: diff changeset	366 IDs for the matching documents, specify `_no_fields`. To retrieve
26e78fe6e8c4 "planemo upload commit c699937486c35866861690329de38ec1a5d9f783" shellac parents: diff changeset	367 the relevance score calculated for each document, specify `_score`.
26e78fe6e8c4 "planemo upload commit c699937486c35866861690329de38ec1a5d9f783" shellac parents: diff changeset	368
26e78fe6e8c4 "planemo upload commit c699937486c35866861690329de38ec1a5d9f783" shellac parents: diff changeset	369 :type size: long
26e78fe6e8c4 "planemo upload commit c699937486c35866861690329de38ec1a5d9f783" shellac parents: diff changeset	370 :param size: Specifies the maximum number of search hits to include in
26e78fe6e8c4 "planemo upload commit c699937486c35866861690329de38ec1a5d9f783" shellac parents: diff changeset	371 the response.
26e78fe6e8c4 "planemo upload commit c699937486c35866861690329de38ec1a5d9f783" shellac parents: diff changeset	372
26e78fe6e8c4 "planemo upload commit c699937486c35866861690329de38ec1a5d9f783" shellac parents: diff changeset	373 :type sort: string
26e78fe6e8c4 "planemo upload commit c699937486c35866861690329de38ec1a5d9f783" shellac parents: diff changeset	374 :param sort: Specifies the fields or custom expressions to use to sort
26e78fe6e8c4 "planemo upload commit c699937486c35866861690329de38ec1a5d9f783" shellac parents: diff changeset	375 the search results. Multiple fields or expressions are specified as
26e78fe6e8c4 "planemo upload commit c699937486c35866861690329de38ec1a5d9f783" shellac parents: diff changeset	376 a comma-separated list. You must specify the sort direction ( `asc`
26e78fe6e8c4 "planemo upload commit c699937486c35866861690329de38ec1a5d9f783" shellac parents: diff changeset	377 or `desc`) for each field; for example, `year desc,title asc`. To
26e78fe6e8c4 "planemo upload commit c699937486c35866861690329de38ec1a5d9f783" shellac parents: diff changeset	378 use a field to sort results, the field must be sort-enabled in the
26e78fe6e8c4 "planemo upload commit c699937486c35866861690329de38ec1a5d9f783" shellac parents: diff changeset	379 domain configuration. Array type fields cannot be used for sorting.
26e78fe6e8c4 "planemo upload commit c699937486c35866861690329de38ec1a5d9f783" shellac parents: diff changeset	380 If no `sort` parameter is specified, results are sorted by their
26e78fe6e8c4 "planemo upload commit c699937486c35866861690329de38ec1a5d9f783" shellac parents: diff changeset	381 default relevance scores in descending order: `_score desc`. You
26e78fe6e8c4 "planemo upload commit c699937486c35866861690329de38ec1a5d9f783" shellac parents: diff changeset	382 can also sort by document ID ( `_id asc`) and version ( `_version
26e78fe6e8c4 "planemo upload commit c699937486c35866861690329de38ec1a5d9f783" shellac parents: diff changeset	383 desc`).
26e78fe6e8c4 "planemo upload commit c699937486c35866861690329de38ec1a5d9f783" shellac parents: diff changeset	384 For more information, see `Sorting Results`_ in the Amazon CloudSearch
26e78fe6e8c4 "planemo upload commit c699937486c35866861690329de38ec1a5d9f783" shellac parents: diff changeset	385 Developer Guide .
26e78fe6e8c4 "planemo upload commit c699937486c35866861690329de38ec1a5d9f783" shellac parents: diff changeset	386
26e78fe6e8c4 "planemo upload commit c699937486c35866861690329de38ec1a5d9f783" shellac parents: diff changeset	387 :type start: long
26e78fe6e8c4 "planemo upload commit c699937486c35866861690329de38ec1a5d9f783" shellac parents: diff changeset	388 :param start: Specifies the offset of the first search hit you want to
26e78fe6e8c4 "planemo upload commit c699937486c35866861690329de38ec1a5d9f783" shellac parents: diff changeset	389 return. Note that the result set is zero-based; the first result is
26e78fe6e8c4 "planemo upload commit c699937486c35866861690329de38ec1a5d9f783" shellac parents: diff changeset	390 at index 0. You can specify either the `start` or `cursor`
26e78fe6e8c4 "planemo upload commit c699937486c35866861690329de38ec1a5d9f783" shellac parents: diff changeset	391 parameter in a request, they are mutually exclusive.
26e78fe6e8c4 "planemo upload commit c699937486c35866861690329de38ec1a5d9f783" shellac parents: diff changeset	392 For more information, see `Paginating Results`_ in the Amazon
26e78fe6e8c4 "planemo upload commit c699937486c35866861690329de38ec1a5d9f783" shellac parents: diff changeset	393 CloudSearch Developer Guide .
26e78fe6e8c4 "planemo upload commit c699937486c35866861690329de38ec1a5d9f783" shellac parents: diff changeset	394
26e78fe6e8c4 "planemo upload commit c699937486c35866861690329de38ec1a5d9f783" shellac parents: diff changeset	395 """
26e78fe6e8c4 "planemo upload commit c699937486c35866861690329de38ec1a5d9f783" shellac parents: diff changeset	396 uri = '/2013-01-01/search'
26e78fe6e8c4 "planemo upload commit c699937486c35866861690329de38ec1a5d9f783" shellac parents: diff changeset	397 params = {}
26e78fe6e8c4 "planemo upload commit c699937486c35866861690329de38ec1a5d9f783" shellac parents: diff changeset	398 headers = {}
26e78fe6e8c4 "planemo upload commit c699937486c35866861690329de38ec1a5d9f783" shellac parents: diff changeset	399 query_params = {}
26e78fe6e8c4 "planemo upload commit c699937486c35866861690329de38ec1a5d9f783" shellac parents: diff changeset	400 if cursor is not None:
26e78fe6e8c4 "planemo upload commit c699937486c35866861690329de38ec1a5d9f783" shellac parents: diff changeset	401 query_params['cursor'] = cursor
26e78fe6e8c4 "planemo upload commit c699937486c35866861690329de38ec1a5d9f783" shellac parents: diff changeset	402 if expr is not None:
26e78fe6e8c4 "planemo upload commit c699937486c35866861690329de38ec1a5d9f783" shellac parents: diff changeset	403 query_params['expr'] = expr
26e78fe6e8c4 "planemo upload commit c699937486c35866861690329de38ec1a5d9f783" shellac parents: diff changeset	404 if facet is not None:
26e78fe6e8c4 "planemo upload commit c699937486c35866861690329de38ec1a5d9f783" shellac parents: diff changeset	405 query_params['facet'] = facet
26e78fe6e8c4 "planemo upload commit c699937486c35866861690329de38ec1a5d9f783" shellac parents: diff changeset	406 if filter_query is not None:
26e78fe6e8c4 "planemo upload commit c699937486c35866861690329de38ec1a5d9f783" shellac parents: diff changeset	407 query_params['fq'] = filter_query
26e78fe6e8c4 "planemo upload commit c699937486c35866861690329de38ec1a5d9f783" shellac parents: diff changeset	408 if highlight is not None:
26e78fe6e8c4 "planemo upload commit c699937486c35866861690329de38ec1a5d9f783" shellac parents: diff changeset	409 query_params['highlight'] = highlight
26e78fe6e8c4 "planemo upload commit c699937486c35866861690329de38ec1a5d9f783" shellac parents: diff changeset	410 if partial is not None:
26e78fe6e8c4 "planemo upload commit c699937486c35866861690329de38ec1a5d9f783" shellac parents: diff changeset	411 query_params['partial'] = partial
26e78fe6e8c4 "planemo upload commit c699937486c35866861690329de38ec1a5d9f783" shellac parents: diff changeset	412 if query is not None:
26e78fe6e8c4 "planemo upload commit c699937486c35866861690329de38ec1a5d9f783" shellac parents: diff changeset	413 query_params['q'] = query
26e78fe6e8c4 "planemo upload commit c699937486c35866861690329de38ec1a5d9f783" shellac parents: diff changeset	414 if query_options is not None:
26e78fe6e8c4 "planemo upload commit c699937486c35866861690329de38ec1a5d9f783" shellac parents: diff changeset	415 query_params['q.options'] = query_options
26e78fe6e8c4 "planemo upload commit c699937486c35866861690329de38ec1a5d9f783" shellac parents: diff changeset	416 if query_parser is not None:
26e78fe6e8c4 "planemo upload commit c699937486c35866861690329de38ec1a5d9f783" shellac parents: diff changeset	417 query_params['q.parser'] = query_parser
26e78fe6e8c4 "planemo upload commit c699937486c35866861690329de38ec1a5d9f783" shellac parents: diff changeset	418 if ret is not None:
26e78fe6e8c4 "planemo upload commit c699937486c35866861690329de38ec1a5d9f783" shellac parents: diff changeset	419 query_params['return'] = ret
26e78fe6e8c4 "planemo upload commit c699937486c35866861690329de38ec1a5d9f783" shellac parents: diff changeset	420 if size is not None:
26e78fe6e8c4 "planemo upload commit c699937486c35866861690329de38ec1a5d9f783" shellac parents: diff changeset	421 query_params['size'] = size
26e78fe6e8c4 "planemo upload commit c699937486c35866861690329de38ec1a5d9f783" shellac parents: diff changeset	422 if sort is not None:
26e78fe6e8c4 "planemo upload commit c699937486c35866861690329de38ec1a5d9f783" shellac parents: diff changeset	423 query_params['sort'] = sort
26e78fe6e8c4 "planemo upload commit c699937486c35866861690329de38ec1a5d9f783" shellac parents: diff changeset	424 if start is not None:
26e78fe6e8c4 "planemo upload commit c699937486c35866861690329de38ec1a5d9f783" shellac parents: diff changeset	425 query_params['start'] = start
26e78fe6e8c4 "planemo upload commit c699937486c35866861690329de38ec1a5d9f783" shellac parents: diff changeset	426 return self.make_request('POST', uri, expected_status=200,
26e78fe6e8c4 "planemo upload commit c699937486c35866861690329de38ec1a5d9f783" shellac parents: diff changeset	427 data=json.dumps(params), headers=headers,
26e78fe6e8c4 "planemo upload commit c699937486c35866861690329de38ec1a5d9f783" shellac parents: diff changeset	428 params=query_params)
26e78fe6e8c4 "planemo upload commit c699937486c35866861690329de38ec1a5d9f783" shellac parents: diff changeset	429
26e78fe6e8c4 "planemo upload commit c699937486c35866861690329de38ec1a5d9f783" shellac parents: diff changeset	430 def suggest(self, query, suggester, size=None):
26e78fe6e8c4 "planemo upload commit c699937486c35866861690329de38ec1a5d9f783" shellac parents: diff changeset	431 """
26e78fe6e8c4 "planemo upload commit c699937486c35866861690329de38ec1a5d9f783" shellac parents: diff changeset	432 Retrieves autocomplete suggestions for a partial query string.
26e78fe6e8c4 "planemo upload commit c699937486c35866861690329de38ec1a5d9f783" shellac parents: diff changeset	433 You can use suggestions enable you to display likely matches
26e78fe6e8c4 "planemo upload commit c699937486c35866861690329de38ec1a5d9f783" shellac parents: diff changeset	434 before users finish typing. In Amazon CloudSearch, suggestions
26e78fe6e8c4 "planemo upload commit c699937486c35866861690329de38ec1a5d9f783" shellac parents: diff changeset	435 are based on the contents of a particular text field. When you
26e78fe6e8c4 "planemo upload commit c699937486c35866861690329de38ec1a5d9f783" shellac parents: diff changeset	436 request suggestions, Amazon CloudSearch finds all of the
26e78fe6e8c4 "planemo upload commit c699937486c35866861690329de38ec1a5d9f783" shellac parents: diff changeset	437 documents whose values in the suggester field start with the
26e78fe6e8c4 "planemo upload commit c699937486c35866861690329de38ec1a5d9f783" shellac parents: diff changeset	438 specified query string. The beginning of the field must match
26e78fe6e8c4 "planemo upload commit c699937486c35866861690329de38ec1a5d9f783" shellac parents: diff changeset	439 the query string to be considered a match.
26e78fe6e8c4 "planemo upload commit c699937486c35866861690329de38ec1a5d9f783" shellac parents: diff changeset	440
26e78fe6e8c4 "planemo upload commit c699937486c35866861690329de38ec1a5d9f783" shellac parents: diff changeset	441 For more information about configuring suggesters and
26e78fe6e8c4 "planemo upload commit c699937486c35866861690329de38ec1a5d9f783" shellac parents: diff changeset	442 retrieving suggestions, see `Getting Suggestions`_ in the
26e78fe6e8c4 "planemo upload commit c699937486c35866861690329de38ec1a5d9f783" shellac parents: diff changeset	443 Amazon CloudSearch Developer Guide .
26e78fe6e8c4 "planemo upload commit c699937486c35866861690329de38ec1a5d9f783" shellac parents: diff changeset	444
26e78fe6e8c4 "planemo upload commit c699937486c35866861690329de38ec1a5d9f783" shellac parents: diff changeset	445 The endpoint for submitting `Suggest` requests is domain-
26e78fe6e8c4 "planemo upload commit c699937486c35866861690329de38ec1a5d9f783" shellac parents: diff changeset	446 specific. You submit suggest requests to a domain's search
26e78fe6e8c4 "planemo upload commit c699937486c35866861690329de38ec1a5d9f783" shellac parents: diff changeset	447 endpoint. To get the search endpoint for your domain, use the
26e78fe6e8c4 "planemo upload commit c699937486c35866861690329de38ec1a5d9f783" shellac parents: diff changeset	448 Amazon CloudSearch configuration service `DescribeDomains`
26e78fe6e8c4 "planemo upload commit c699937486c35866861690329de38ec1a5d9f783" shellac parents: diff changeset	449 action. A domain's endpoints are also displayed on the domain
26e78fe6e8c4 "planemo upload commit c699937486c35866861690329de38ec1a5d9f783" shellac parents: diff changeset	450 dashboard in the Amazon CloudSearch console.
26e78fe6e8c4 "planemo upload commit c699937486c35866861690329de38ec1a5d9f783" shellac parents: diff changeset	451
26e78fe6e8c4 "planemo upload commit c699937486c35866861690329de38ec1a5d9f783" shellac parents: diff changeset	452 :type query: string
26e78fe6e8c4 "planemo upload commit c699937486c35866861690329de38ec1a5d9f783" shellac parents: diff changeset	453 :param query: Specifies the string for which you want to get
26e78fe6e8c4 "planemo upload commit c699937486c35866861690329de38ec1a5d9f783" shellac parents: diff changeset	454 suggestions.
26e78fe6e8c4 "planemo upload commit c699937486c35866861690329de38ec1a5d9f783" shellac parents: diff changeset	455
26e78fe6e8c4 "planemo upload commit c699937486c35866861690329de38ec1a5d9f783" shellac parents: diff changeset	456 :type suggester: string
26e78fe6e8c4 "planemo upload commit c699937486c35866861690329de38ec1a5d9f783" shellac parents: diff changeset	457 :param suggester: Specifies the name of the suggester to use to find
26e78fe6e8c4 "planemo upload commit c699937486c35866861690329de38ec1a5d9f783" shellac parents: diff changeset	458 suggested matches.
26e78fe6e8c4 "planemo upload commit c699937486c35866861690329de38ec1a5d9f783" shellac parents: diff changeset	459
26e78fe6e8c4 "planemo upload commit c699937486c35866861690329de38ec1a5d9f783" shellac parents: diff changeset	460 :type size: long
26e78fe6e8c4 "planemo upload commit c699937486c35866861690329de38ec1a5d9f783" shellac parents: diff changeset	461 :param size: Specifies the maximum number of suggestions to return.
26e78fe6e8c4 "planemo upload commit c699937486c35866861690329de38ec1a5d9f783" shellac parents: diff changeset	462
26e78fe6e8c4 "planemo upload commit c699937486c35866861690329de38ec1a5d9f783" shellac parents: diff changeset	463 """
26e78fe6e8c4 "planemo upload commit c699937486c35866861690329de38ec1a5d9f783" shellac parents: diff changeset	464 uri = '/2013-01-01/suggest'
26e78fe6e8c4 "planemo upload commit c699937486c35866861690329de38ec1a5d9f783" shellac parents: diff changeset	465 params = {}
26e78fe6e8c4 "planemo upload commit c699937486c35866861690329de38ec1a5d9f783" shellac parents: diff changeset	466 headers = {}
26e78fe6e8c4 "planemo upload commit c699937486c35866861690329de38ec1a5d9f783" shellac parents: diff changeset	467 query_params = {}
26e78fe6e8c4 "planemo upload commit c699937486c35866861690329de38ec1a5d9f783" shellac parents: diff changeset	468 if query is not None:
26e78fe6e8c4 "planemo upload commit c699937486c35866861690329de38ec1a5d9f783" shellac parents: diff changeset	469 query_params['q'] = query
26e78fe6e8c4 "planemo upload commit c699937486c35866861690329de38ec1a5d9f783" shellac parents: diff changeset	470 if suggester is not None:
26e78fe6e8c4 "planemo upload commit c699937486c35866861690329de38ec1a5d9f783" shellac parents: diff changeset	471 query_params['suggester'] = suggester
26e78fe6e8c4 "planemo upload commit c699937486c35866861690329de38ec1a5d9f783" shellac parents: diff changeset	472 if size is not None:
26e78fe6e8c4 "planemo upload commit c699937486c35866861690329de38ec1a5d9f783" shellac parents: diff changeset	473 query_params['size'] = size
26e78fe6e8c4 "planemo upload commit c699937486c35866861690329de38ec1a5d9f783" shellac parents: diff changeset	474 return self.make_request('GET', uri, expected_status=200,
26e78fe6e8c4 "planemo upload commit c699937486c35866861690329de38ec1a5d9f783" shellac parents: diff changeset	475 data=json.dumps(params), headers=headers,
26e78fe6e8c4 "planemo upload commit c699937486c35866861690329de38ec1a5d9f783" shellac parents: diff changeset	476 params=query_params)
26e78fe6e8c4 "planemo upload commit c699937486c35866861690329de38ec1a5d9f783" shellac parents: diff changeset	477
26e78fe6e8c4 "planemo upload commit c699937486c35866861690329de38ec1a5d9f783" shellac parents: diff changeset	478 def upload_documents(self, documents, content_type):
26e78fe6e8c4 "planemo upload commit c699937486c35866861690329de38ec1a5d9f783" shellac parents: diff changeset	479 """
26e78fe6e8c4 "planemo upload commit c699937486c35866861690329de38ec1a5d9f783" shellac parents: diff changeset	480 Posts a batch of documents to a search domain for indexing. A
26e78fe6e8c4 "planemo upload commit c699937486c35866861690329de38ec1a5d9f783" shellac parents: diff changeset	481 document batch is a collection of add and delete operations
26e78fe6e8c4 "planemo upload commit c699937486c35866861690329de38ec1a5d9f783" shellac parents: diff changeset	482 that represent the documents you want to add, update, or
26e78fe6e8c4 "planemo upload commit c699937486c35866861690329de38ec1a5d9f783" shellac parents: diff changeset	483 delete from your domain. Batches can be described in either
26e78fe6e8c4 "planemo upload commit c699937486c35866861690329de38ec1a5d9f783" shellac parents: diff changeset	484 JSON or XML. Each item that you want Amazon CloudSearch to
26e78fe6e8c4 "planemo upload commit c699937486c35866861690329de38ec1a5d9f783" shellac parents: diff changeset	485 return as a search result (such as a product) is represented
26e78fe6e8c4 "planemo upload commit c699937486c35866861690329de38ec1a5d9f783" shellac parents: diff changeset	486 as a document. Every document has a unique ID and one or more
26e78fe6e8c4 "planemo upload commit c699937486c35866861690329de38ec1a5d9f783" shellac parents: diff changeset	487 fields that contain the data that you want to search and
26e78fe6e8c4 "planemo upload commit c699937486c35866861690329de38ec1a5d9f783" shellac parents: diff changeset	488 return in results. Individual documents cannot contain more
26e78fe6e8c4 "planemo upload commit c699937486c35866861690329de38ec1a5d9f783" shellac parents: diff changeset	489 than 1 MB of data. The entire batch cannot exceed 5 MB. To get
26e78fe6e8c4 "planemo upload commit c699937486c35866861690329de38ec1a5d9f783" shellac parents: diff changeset	490 the best possible upload performance, group add and delete
26e78fe6e8c4 "planemo upload commit c699937486c35866861690329de38ec1a5d9f783" shellac parents: diff changeset	491 operations in batches that are close the 5 MB limit.
26e78fe6e8c4 "planemo upload commit c699937486c35866861690329de38ec1a5d9f783" shellac parents: diff changeset	492 Submitting a large volume of single-document batches can
26e78fe6e8c4 "planemo upload commit c699937486c35866861690329de38ec1a5d9f783" shellac parents: diff changeset	493 overload a domain's document service.
26e78fe6e8c4 "planemo upload commit c699937486c35866861690329de38ec1a5d9f783" shellac parents: diff changeset	494
26e78fe6e8c4 "planemo upload commit c699937486c35866861690329de38ec1a5d9f783" shellac parents: diff changeset	495 The endpoint for submitting `UploadDocuments` requests is
26e78fe6e8c4 "planemo upload commit c699937486c35866861690329de38ec1a5d9f783" shellac parents: diff changeset	496 domain-specific. To get the document endpoint for your domain,
26e78fe6e8c4 "planemo upload commit c699937486c35866861690329de38ec1a5d9f783" shellac parents: diff changeset	497 use the Amazon CloudSearch configuration service
26e78fe6e8c4 "planemo upload commit c699937486c35866861690329de38ec1a5d9f783" shellac parents: diff changeset	498 `DescribeDomains` action. A domain's endpoints are also
26e78fe6e8c4 "planemo upload commit c699937486c35866861690329de38ec1a5d9f783" shellac parents: diff changeset	499 displayed on the domain dashboard in the Amazon CloudSearch
26e78fe6e8c4 "planemo upload commit c699937486c35866861690329de38ec1a5d9f783" shellac parents: diff changeset	500 console.

0

26e78fe6e8c4 "planemo upload commit c699937486c35866861690329de38ec1a5d9f783"

shellac

parents:

diff changeset

26e78fe6e8c4 "planemo upload commit c699937486c35866861690329de38ec1a5d9f783"

shellac

parents:

diff changeset

2 #

26e78fe6e8c4 "planemo upload commit c699937486c35866861690329de38ec1a5d9f783"

shellac

parents:

diff changeset

3 # Permission is hereby granted, free of charge, to any person obtaining a

26e78fe6e8c4 "planemo upload commit c699937486c35866861690329de38ec1a5d9f783"

shellac

parents:

diff changeset

4 # copy of this software and associated documentation files (the

26e78fe6e8c4 "planemo upload commit c699937486c35866861690329de38ec1a5d9f783"

shellac

parents:

diff changeset

5 # "Software"), to deal in the Software without restriction, including

26e78fe6e8c4 "planemo upload commit c699937486c35866861690329de38ec1a5d9f783"

shellac

parents:

diff changeset

6 # without limitation the rights to use, copy, modify, merge, publish, dis-

26e78fe6e8c4 "planemo upload commit c699937486c35866861690329de38ec1a5d9f783"

shellac

parents:

diff changeset

7 # tribute, sublicense, and/or sell copies of the Software, and to permit

26e78fe6e8c4 "planemo upload commit c699937486c35866861690329de38ec1a5d9f783"

shellac

parents:

diff changeset

8 # persons to whom the Software is furnished to do so, subject to the fol-

26e78fe6e8c4 "planemo upload commit c699937486c35866861690329de38ec1a5d9f783"

shellac

parents:

diff changeset

9 # lowing conditions:

26e78fe6e8c4 "planemo upload commit c699937486c35866861690329de38ec1a5d9f783"

shellac

parents:

diff changeset

10 #

26e78fe6e8c4 "planemo upload commit c699937486c35866861690329de38ec1a5d9f783"

shellac

parents:

diff changeset

11 # The above copyright notice and this permission notice shall be included

26e78fe6e8c4 "planemo upload commit c699937486c35866861690329de38ec1a5d9f783"

shellac

parents:

diff changeset

12 # in all copies or substantial portions of the Software.

26e78fe6e8c4 "planemo upload commit c699937486c35866861690329de38ec1a5d9f783"

shellac

parents:

diff changeset

13 #

26e78fe6e8c4 "planemo upload commit c699937486c35866861690329de38ec1a5d9f783"

shellac

parents:

diff changeset

14 # THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS

26e78fe6e8c4 "planemo upload commit c699937486c35866861690329de38ec1a5d9f783"

shellac

parents:

diff changeset

15 # OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABIL-

26e78fe6e8c4 "planemo upload commit c699937486c35866861690329de38ec1a5d9f783"

shellac

parents:

diff changeset

16 # ITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT

26e78fe6e8c4 "planemo upload commit c699937486c35866861690329de38ec1a5d9f783"

shellac

parents:

diff changeset

17 # SHALL THE AUTHOR BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY,

26e78fe6e8c4 "planemo upload commit c699937486c35866861690329de38ec1a5d9f783"

shellac

parents:

diff changeset

18 # WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,

26e78fe6e8c4 "planemo upload commit c699937486c35866861690329de38ec1a5d9f783"

shellac

parents:

diff changeset

19 # OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS

26e78fe6e8c4 "planemo upload commit c699937486c35866861690329de38ec1a5d9f783"

shellac

parents:

diff changeset

20 # IN THE SOFTWARE.

26e78fe6e8c4 "planemo upload commit c699937486c35866861690329de38ec1a5d9f783"

shellac

parents:

diff changeset

21 #

26e78fe6e8c4 "planemo upload commit c699937486c35866861690329de38ec1a5d9f783"

shellac

parents:

diff changeset

22 from boto.compat import json

26e78fe6e8c4 "planemo upload commit c699937486c35866861690329de38ec1a5d9f783"

shellac

parents:

diff changeset

23 from boto.exception import JSONResponseError

26e78fe6e8c4 "planemo upload commit c699937486c35866861690329de38ec1a5d9f783"

shellac

parents:

diff changeset

24 from boto.connection import AWSAuthConnection

26e78fe6e8c4 "planemo upload commit c699937486c35866861690329de38ec1a5d9f783"

shellac

parents:

diff changeset

25 from boto.regioninfo import RegionInfo

26e78fe6e8c4 "planemo upload commit c699937486c35866861690329de38ec1a5d9f783"

shellac

parents:

diff changeset

26 from boto.cloudsearchdomain import exceptions

26e78fe6e8c4 "planemo upload commit c699937486c35866861690329de38ec1a5d9f783"

shellac

parents:

diff changeset

27

26e78fe6e8c4 "planemo upload commit c699937486c35866861690329de38ec1a5d9f783"

shellac

parents:

diff changeset

28

26e78fe6e8c4 "planemo upload commit c699937486c35866861690329de38ec1a5d9f783"

shellac

parents:

diff changeset

29 class CloudSearchDomainConnection(AWSAuthConnection):

26e78fe6e8c4 "planemo upload commit c699937486c35866861690329de38ec1a5d9f783"

shellac

parents:

diff changeset

30 """

26e78fe6e8c4 "planemo upload commit c699937486c35866861690329de38ec1a5d9f783"

shellac

parents:

diff changeset

31 You use the AmazonCloudSearch2013 API to upload documents to a

26e78fe6e8c4 "planemo upload commit c699937486c35866861690329de38ec1a5d9f783"

shellac

parents:

diff changeset

32 search domain and search those documents.

26e78fe6e8c4 "planemo upload commit c699937486c35866861690329de38ec1a5d9f783"

shellac

parents:

diff changeset

33

26e78fe6e8c4 "planemo upload commit c699937486c35866861690329de38ec1a5d9f783"

shellac

parents:

diff changeset

34 The endpoints for submitting `UploadDocuments`, `Search`, and

26e78fe6e8c4 "planemo upload commit c699937486c35866861690329de38ec1a5d9f783"

shellac

parents:

diff changeset

35 `Suggest` requests are domain-specific. To get the endpoints for

26e78fe6e8c4 "planemo upload commit c699937486c35866861690329de38ec1a5d9f783"

shellac

parents:

diff changeset

36 your domain, use the Amazon CloudSearch configuration service

26e78fe6e8c4 "planemo upload commit c699937486c35866861690329de38ec1a5d9f783"

shellac

parents:

diff changeset

37 `DescribeDomains` action. The domain endpoints are also displayed

26e78fe6e8c4 "planemo upload commit c699937486c35866861690329de38ec1a5d9f783"

shellac

parents:

diff changeset

38 on the domain dashboard in the Amazon CloudSearch console. You

26e78fe6e8c4 "planemo upload commit c699937486c35866861690329de38ec1a5d9f783"

shellac

parents:

diff changeset

39 submit suggest requests to the search endpoint.

26e78fe6e8c4 "planemo upload commit c699937486c35866861690329de38ec1a5d9f783"

shellac

parents:

diff changeset

40

26e78fe6e8c4 "planemo upload commit c699937486c35866861690329de38ec1a5d9f783"

shellac

parents:

diff changeset

41 For more information, see the `Amazon CloudSearch Developer

26e78fe6e8c4 "planemo upload commit c699937486c35866861690329de38ec1a5d9f783"

shellac

parents:

diff changeset

42 Guide`_.

26e78fe6e8c4 "planemo upload commit c699937486c35866861690329de38ec1a5d9f783"

shellac

parents:

diff changeset

43 """

26e78fe6e8c4 "planemo upload commit c699937486c35866861690329de38ec1a5d9f783"

shellac

parents:

diff changeset

44 APIVersion = "2013-01-01"

26e78fe6e8c4 "planemo upload commit c699937486c35866861690329de38ec1a5d9f783"

shellac

parents:

diff changeset

45 AuthServiceName = 'cloudsearch'

26e78fe6e8c4 "planemo upload commit c699937486c35866861690329de38ec1a5d9f783"

shellac

parents:

diff changeset

46 DefaultRegionName = "us-east-1"

26e78fe6e8c4 "planemo upload commit c699937486c35866861690329de38ec1a5d9f783"

shellac

parents:

diff changeset

47 DefaultRegionEndpoint = "cloudsearch.us-east-1.amazonaws.com"

26e78fe6e8c4 "planemo upload commit c699937486c35866861690329de38ec1a5d9f783"

shellac

parents:

diff changeset

48 ResponseError = JSONResponseError

26e78fe6e8c4 "planemo upload commit c699937486c35866861690329de38ec1a5d9f783"

shellac

parents:

diff changeset

49

26e78fe6e8c4 "planemo upload commit c699937486c35866861690329de38ec1a5d9f783"

shellac

parents:

diff changeset

50 _faults = {

26e78fe6e8c4 "planemo upload commit c699937486c35866861690329de38ec1a5d9f783"

shellac

parents:

diff changeset

51 "SearchException": exceptions.SearchException,

26e78fe6e8c4 "planemo upload commit c699937486c35866861690329de38ec1a5d9f783"

shellac

parents:

diff changeset

52 "DocumentServiceException": exceptions.DocumentServiceException,

26e78fe6e8c4 "planemo upload commit c699937486c35866861690329de38ec1a5d9f783"

shellac

parents:

diff changeset

53 }

26e78fe6e8c4 "planemo upload commit c699937486c35866861690329de38ec1a5d9f783"

shellac

parents:

diff changeset

54

26e78fe6e8c4 "planemo upload commit c699937486c35866861690329de38ec1a5d9f783"

shellac

parents:

diff changeset

55 def __init__(self, **kwargs):

26e78fe6e8c4 "planemo upload commit c699937486c35866861690329de38ec1a5d9f783"

shellac

parents:

diff changeset

56 region = kwargs.get('region')

26e78fe6e8c4 "planemo upload commit c699937486c35866861690329de38ec1a5d9f783"

shellac

parents:

diff changeset

57 if not region:

26e78fe6e8c4 "planemo upload commit c699937486c35866861690329de38ec1a5d9f783"

shellac

parents:

diff changeset

58 region = RegionInfo(self, self.DefaultRegionName,

26e78fe6e8c4 "planemo upload commit c699937486c35866861690329de38ec1a5d9f783"

shellac

parents:

diff changeset

59 self.DefaultRegionEndpoint)

26e78fe6e8c4 "planemo upload commit c699937486c35866861690329de38ec1a5d9f783"

shellac

parents:

diff changeset

60 else:

26e78fe6e8c4 "planemo upload commit c699937486c35866861690329de38ec1a5d9f783"

shellac

parents:

diff changeset

61 del kwargs['region']

26e78fe6e8c4 "planemo upload commit c699937486c35866861690329de38ec1a5d9f783"

shellac

parents:

diff changeset

62 if kwargs.get('host', None) is None:

26e78fe6e8c4 "planemo upload commit c699937486c35866861690329de38ec1a5d9f783"

shellac

parents:

diff changeset

63 raise ValueError(

26e78fe6e8c4 "planemo upload commit c699937486c35866861690329de38ec1a5d9f783"

shellac

parents:

diff changeset

64 'The argument, host, must be provided when creating a '

26e78fe6e8c4 "planemo upload commit c699937486c35866861690329de38ec1a5d9f783"

shellac

parents:

diff changeset

65 'CloudSearchDomainConnection because its methods require the '

26e78fe6e8c4 "planemo upload commit c699937486c35866861690329de38ec1a5d9f783"

shellac

parents:

diff changeset

66 'specific domain\'s endpoint in order to successfully make '

26e78fe6e8c4 "planemo upload commit c699937486c35866861690329de38ec1a5d9f783"

shellac

parents:

diff changeset

67 'requests to that CloudSearch Domain.'

26e78fe6e8c4 "planemo upload commit c699937486c35866861690329de38ec1a5d9f783"

shellac

parents:

diff changeset

68 )

26e78fe6e8c4 "planemo upload commit c699937486c35866861690329de38ec1a5d9f783"

shellac

parents:

diff changeset

69 super(CloudSearchDomainConnection, self).__init__(**kwargs)

26e78fe6e8c4 "planemo upload commit c699937486c35866861690329de38ec1a5d9f783"

shellac

parents:

diff changeset

70 self.region = region

26e78fe6e8c4 "planemo upload commit c699937486c35866861690329de38ec1a5d9f783"

shellac

parents:

diff changeset

71

26e78fe6e8c4 "planemo upload commit c699937486c35866861690329de38ec1a5d9f783"

shellac

parents:

diff changeset

72 def _required_auth_capability(self):

26e78fe6e8c4 "planemo upload commit c699937486c35866861690329de38ec1a5d9f783"

shellac

parents:

diff changeset

73 return ['hmac-v4']

26e78fe6e8c4 "planemo upload commit c699937486c35866861690329de38ec1a5d9f783"

shellac

parents:

diff changeset

74

26e78fe6e8c4 "planemo upload commit c699937486c35866861690329de38ec1a5d9f783"

shellac

parents:

diff changeset

75 def search(self, query, cursor=None, expr=None, facet=None,

26e78fe6e8c4 "planemo upload commit c699937486c35866861690329de38ec1a5d9f783"

shellac

parents:

diff changeset

76 filter_query=None, highlight=None, partial=None,

26e78fe6e8c4 "planemo upload commit c699937486c35866861690329de38ec1a5d9f783"

shellac

parents:

diff changeset

77 query_options=None, query_parser=None, ret=None, size=None,

26e78fe6e8c4 "planemo upload commit c699937486c35866861690329de38ec1a5d9f783"

shellac

parents:

diff changeset

78 sort=None, start=None):

26e78fe6e8c4 "planemo upload commit c699937486c35866861690329de38ec1a5d9f783"

shellac

parents:

diff changeset

79 """

26e78fe6e8c4 "planemo upload commit c699937486c35866861690329de38ec1a5d9f783"

shellac

parents:

diff changeset

80 Retrieves a list of documents that match the specified search

26e78fe6e8c4 "planemo upload commit c699937486c35866861690329de38ec1a5d9f783"

shellac

parents:

diff changeset

81 criteria. How you specify the search criteria depends on which

26e78fe6e8c4 "planemo upload commit c699937486c35866861690329de38ec1a5d9f783"

shellac

parents:

diff changeset

82 query parser you use. Amazon CloudSearch supports four query

26e78fe6e8c4 "planemo upload commit c699937486c35866861690329de38ec1a5d9f783"

shellac

parents:

diff changeset

83 parsers:

26e78fe6e8c4 "planemo upload commit c699937486c35866861690329de38ec1a5d9f783"

shellac

parents:

diff changeset

84

26e78fe6e8c4 "planemo upload commit c699937486c35866861690329de38ec1a5d9f783"

shellac

parents:

diff changeset

85

26e78fe6e8c4 "planemo upload commit c699937486c35866861690329de38ec1a5d9f783"

shellac

parents:

diff changeset

86 + `simple`: search all `text` and `text-array` fields for the

26e78fe6e8c4 "planemo upload commit c699937486c35866861690329de38ec1a5d9f783"

shellac

parents:

diff changeset

87 specified string. Search for phrases, individual terms, and

26e78fe6e8c4 "planemo upload commit c699937486c35866861690329de38ec1a5d9f783"

shellac

parents:

diff changeset

88 prefixes.

26e78fe6e8c4 "planemo upload commit c699937486c35866861690329de38ec1a5d9f783"

shellac

parents:

diff changeset

89 + `structured`: search specific fields, construct compound

26e78fe6e8c4 "planemo upload commit c699937486c35866861690329de38ec1a5d9f783"

shellac

parents:

diff changeset

90 queries using Boolean operators, and use advanced features

26e78fe6e8c4 "planemo upload commit c699937486c35866861690329de38ec1a5d9f783"

shellac

parents:

diff changeset

91 such as term boosting and proximity searching.

26e78fe6e8c4 "planemo upload commit c699937486c35866861690329de38ec1a5d9f783"

shellac

parents:

diff changeset

92 + `lucene`: specify search criteria using the Apache Lucene

26e78fe6e8c4 "planemo upload commit c699937486c35866861690329de38ec1a5d9f783"

shellac

parents:

diff changeset

93 query parser syntax.

26e78fe6e8c4 "planemo upload commit c699937486c35866861690329de38ec1a5d9f783"

shellac

parents:

diff changeset

94 + `dismax`: specify search criteria using the simplified

26e78fe6e8c4 "planemo upload commit c699937486c35866861690329de38ec1a5d9f783"

shellac

parents:

diff changeset

95 subset of the Apache Lucene query parser syntax defined by the

26e78fe6e8c4 "planemo upload commit c699937486c35866861690329de38ec1a5d9f783"

shellac

parents:

diff changeset

96 DisMax query parser.

26e78fe6e8c4 "planemo upload commit c699937486c35866861690329de38ec1a5d9f783"

shellac

parents:

diff changeset

97

26e78fe6e8c4 "planemo upload commit c699937486c35866861690329de38ec1a5d9f783"

shellac

parents:

diff changeset

98

26e78fe6e8c4 "planemo upload commit c699937486c35866861690329de38ec1a5d9f783"

shellac

parents:

diff changeset

99 For more information, see `Searching Your Data`_ in the Amazon

26e78fe6e8c4 "planemo upload commit c699937486c35866861690329de38ec1a5d9f783"

shellac

parents:

diff changeset

100 CloudSearch Developer Guide .

26e78fe6e8c4 "planemo upload commit c699937486c35866861690329de38ec1a5d9f783"

shellac

parents:

diff changeset

101

26e78fe6e8c4 "planemo upload commit c699937486c35866861690329de38ec1a5d9f783"

shellac

parents:

diff changeset

102 The endpoint for submitting `Search` requests is domain-

26e78fe6e8c4 "planemo upload commit c699937486c35866861690329de38ec1a5d9f783"

shellac

parents:

diff changeset

103 specific. You submit search requests to a domain's search

26e78fe6e8c4 "planemo upload commit c699937486c35866861690329de38ec1a5d9f783"

shellac

parents:

diff changeset

104 endpoint. To get the search endpoint for your domain, use the

26e78fe6e8c4 "planemo upload commit c699937486c35866861690329de38ec1a5d9f783"

shellac

parents:

diff changeset

105 Amazon CloudSearch configuration service `DescribeDomains`

26e78fe6e8c4 "planemo upload commit c699937486c35866861690329de38ec1a5d9f783"

shellac

parents:

diff changeset

106 action. A domain's endpoints are also displayed on the domain

26e78fe6e8c4 "planemo upload commit c699937486c35866861690329de38ec1a5d9f783"

shellac

parents:

diff changeset

107 dashboard in the Amazon CloudSearch console.

26e78fe6e8c4 "planemo upload commit c699937486c35866861690329de38ec1a5d9f783"

shellac

parents:

diff changeset

108

26e78fe6e8c4 "planemo upload commit c699937486c35866861690329de38ec1a5d9f783"

shellac

parents:

diff changeset

109 :type cursor: string

26e78fe6e8c4 "planemo upload commit c699937486c35866861690329de38ec1a5d9f783"

shellac

parents:

diff changeset

110 :param cursor: Retrieves a cursor value you can use to page through

26e78fe6e8c4 "planemo upload commit c699937486c35866861690329de38ec1a5d9f783"

shellac

parents:

diff changeset

111 large result sets. Use the `size` parameter to control the number

26e78fe6e8c4 "planemo upload commit c699937486c35866861690329de38ec1a5d9f783"

shellac

parents:

diff changeset

112 of hits to include in each response. You can specify either the

26e78fe6e8c4 "planemo upload commit c699937486c35866861690329de38ec1a5d9f783"

shellac

parents:

diff changeset

113 `cursor` or `start` parameter in a request; they are mutually

26e78fe6e8c4 "planemo upload commit c699937486c35866861690329de38ec1a5d9f783"

shellac

parents:

diff changeset

114 exclusive. To get the first cursor, set the cursor value to

26e78fe6e8c4 "planemo upload commit c699937486c35866861690329de38ec1a5d9f783"

shellac

parents:

diff changeset

115 `initial`. In subsequent requests, specify the cursor value

26e78fe6e8c4 "planemo upload commit c699937486c35866861690329de38ec1a5d9f783"

shellac

parents:

diff changeset

116 returned in the hits section of the response.

26e78fe6e8c4 "planemo upload commit c699937486c35866861690329de38ec1a5d9f783"

shellac

parents:

diff changeset

117 For more information, see `Paginating Results`_ in the Amazon

26e78fe6e8c4 "planemo upload commit c699937486c35866861690329de38ec1a5d9f783"

shellac

parents:

diff changeset

118 CloudSearch Developer Guide .

26e78fe6e8c4 "planemo upload commit c699937486c35866861690329de38ec1a5d9f783"

shellac

parents:

diff changeset

119

26e78fe6e8c4 "planemo upload commit c699937486c35866861690329de38ec1a5d9f783"

shellac

parents:

diff changeset

120 :type expr: string

26e78fe6e8c4 "planemo upload commit c699937486c35866861690329de38ec1a5d9f783"

shellac

parents:

diff changeset

121 :param expr: Defines one or more numeric expressions that can be used

26e78fe6e8c4 "planemo upload commit c699937486c35866861690329de38ec1a5d9f783"

shellac

parents:

diff changeset

122 to sort results or specify search or filter criteria. You can also

26e78fe6e8c4 "planemo upload commit c699937486c35866861690329de38ec1a5d9f783"

shellac

parents:

diff changeset

123 specify expressions as return fields.

26e78fe6e8c4 "planemo upload commit c699937486c35866861690329de38ec1a5d9f783"

shellac

parents:

diff changeset

124 For more information about defining and using expressions, see

26e78fe6e8c4 "planemo upload commit c699937486c35866861690329de38ec1a5d9f783"

shellac

parents:

diff changeset

125 `Configuring Expressions`_ in the Amazon CloudSearch Developer

26e78fe6e8c4 "planemo upload commit c699937486c35866861690329de38ec1a5d9f783"

shellac

parents:

diff changeset

126 Guide .

26e78fe6e8c4 "planemo upload commit c699937486c35866861690329de38ec1a5d9f783"

shellac

parents:

diff changeset

127

26e78fe6e8c4 "planemo upload commit c699937486c35866861690329de38ec1a5d9f783"

shellac

parents:

diff changeset

128 :type facet: string

26e78fe6e8c4 "planemo upload commit c699937486c35866861690329de38ec1a5d9f783"

shellac

parents:

diff changeset

129 :param facet: Specifies one or more fields for which to get facet

26e78fe6e8c4 "planemo upload commit c699937486c35866861690329de38ec1a5d9f783"

shellac

parents:

diff changeset

130 information, and options that control how the facet information is

26e78fe6e8c4 "planemo upload commit c699937486c35866861690329de38ec1a5d9f783"

shellac

parents:

diff changeset

131 returned. Each specified field must be facet-enabled in the domain

26e78fe6e8c4 "planemo upload commit c699937486c35866861690329de38ec1a5d9f783"

shellac

parents:

diff changeset

132 configuration. The fields and options are specified in JSON using

26e78fe6e8c4 "planemo upload commit c699937486c35866861690329de38ec1a5d9f783"

shellac

parents:

diff changeset

133 the form `{"FIELD":{"OPTION":VALUE,"OPTION:"STRING"},"FIELD":{"OPTI

26e78fe6e8c4 "planemo upload commit c699937486c35866861690329de38ec1a5d9f783"

shellac

parents:

diff changeset

134 ON":VALUE,"OPTION":"STRING"}}`.

26e78fe6e8c4 "planemo upload commit c699937486c35866861690329de38ec1a5d9f783"

shellac

parents:

diff changeset

135 You can specify the following faceting options:

26e78fe6e8c4 "planemo upload commit c699937486c35866861690329de38ec1a5d9f783"

shellac

parents:

diff changeset

136

26e78fe6e8c4 "planemo upload commit c699937486c35866861690329de38ec1a5d9f783"

shellac

parents:

diff changeset

137

26e78fe6e8c4 "planemo upload commit c699937486c35866861690329de38ec1a5d9f783"

shellac

parents:

diff changeset

138 + `buckets` specifies an array of the facet values or ranges to count.

26e78fe6e8c4 "planemo upload commit c699937486c35866861690329de38ec1a5d9f783"

shellac

parents:

diff changeset

139 Ranges are specified using the same syntax that you use to search

26e78fe6e8c4 "planemo upload commit c699937486c35866861690329de38ec1a5d9f783"

shellac

parents:

diff changeset

140 for a range of values. For more information, see ` Searching for a

26e78fe6e8c4 "planemo upload commit c699937486c35866861690329de38ec1a5d9f783"

shellac

parents:

diff changeset

141 Range of Values`_ in the Amazon CloudSearch Developer Guide .

26e78fe6e8c4 "planemo upload commit c699937486c35866861690329de38ec1a5d9f783"

shellac

parents:

diff changeset

142 Buckets are returned in the order they are specified in the

26e78fe6e8c4 "planemo upload commit c699937486c35866861690329de38ec1a5d9f783"

shellac

parents:

diff changeset

143 request. The `sort` and `size` options are not valid if you specify

26e78fe6e8c4 "planemo upload commit c699937486c35866861690329de38ec1a5d9f783"

shellac

parents:

diff changeset

144 `buckets`.

26e78fe6e8c4 "planemo upload commit c699937486c35866861690329de38ec1a5d9f783"

shellac

parents:

diff changeset

145 + `size` specifies the maximum number of facets to include in the

26e78fe6e8c4 "planemo upload commit c699937486c35866861690329de38ec1a5d9f783"

shellac

parents:

diff changeset

146 results. By default, Amazon CloudSearch returns counts for the top

26e78fe6e8c4 "planemo upload commit c699937486c35866861690329de38ec1a5d9f783"

shellac

parents:

diff changeset

147 10. The `size` parameter is only valid when you specify the `sort`

26e78fe6e8c4 "planemo upload commit c699937486c35866861690329de38ec1a5d9f783"

shellac

parents:

diff changeset

148 option; it cannot be used in conjunction with `buckets`.

26e78fe6e8c4 "planemo upload commit c699937486c35866861690329de38ec1a5d9f783"

shellac

parents:

diff changeset

149 + `sort` specifies how you want to sort the facets in the results:

26e78fe6e8c4 "planemo upload commit c699937486c35866861690329de38ec1a5d9f783"

shellac

parents:

diff changeset

150 `bucket` or `count`. Specify `bucket` to sort alphabetically or

26e78fe6e8c4 "planemo upload commit c699937486c35866861690329de38ec1a5d9f783"

shellac

parents:

diff changeset

151 numerically by facet value (in ascending order). Specify `count` to

26e78fe6e8c4 "planemo upload commit c699937486c35866861690329de38ec1a5d9f783"

shellac

parents:

diff changeset

152 sort by the facet counts computed for each facet value (in

26e78fe6e8c4 "planemo upload commit c699937486c35866861690329de38ec1a5d9f783"

shellac

parents:

diff changeset

153 descending order). To retrieve facet counts for particular values

26e78fe6e8c4 "planemo upload commit c699937486c35866861690329de38ec1a5d9f783"

shellac

parents:

diff changeset

154 or ranges of values, use the `buckets` option instead of `sort`.

26e78fe6e8c4 "planemo upload commit c699937486c35866861690329de38ec1a5d9f783"

shellac

parents:

diff changeset

155

26e78fe6e8c4 "planemo upload commit c699937486c35866861690329de38ec1a5d9f783"

shellac

parents:

diff changeset

156

26e78fe6e8c4 "planemo upload commit c699937486c35866861690329de38ec1a5d9f783"

shellac

parents:

diff changeset

157 If no facet options are specified, facet counts are computed for all

26e78fe6e8c4 "planemo upload commit c699937486c35866861690329de38ec1a5d9f783"

shellac

parents:

diff changeset

158 field values, the facets are sorted by facet count, and the top 10

26e78fe6e8c4 "planemo upload commit c699937486c35866861690329de38ec1a5d9f783"

shellac

parents:

diff changeset

159 facets are returned in the results.

26e78fe6e8c4 "planemo upload commit c699937486c35866861690329de38ec1a5d9f783"

shellac

parents:

diff changeset

160

26e78fe6e8c4 "planemo upload commit c699937486c35866861690329de38ec1a5d9f783"

shellac

parents:

diff changeset

161 For more information, see `Getting and Using Facet Information`_ in the

26e78fe6e8c4 "planemo upload commit c699937486c35866861690329de38ec1a5d9f783"

shellac

parents:

diff changeset

162 Amazon CloudSearch Developer Guide .

26e78fe6e8c4 "planemo upload commit c699937486c35866861690329de38ec1a5d9f783"

shellac

parents:

diff changeset

163

26e78fe6e8c4 "planemo upload commit c699937486c35866861690329de38ec1a5d9f783"

shellac

parents:

diff changeset

164 :type filter_query: string

26e78fe6e8c4 "planemo upload commit c699937486c35866861690329de38ec1a5d9f783"

shellac

parents:

diff changeset

165 :param filter_query: Specifies a structured query that filters the

26e78fe6e8c4 "planemo upload commit c699937486c35866861690329de38ec1a5d9f783"

shellac

parents:

diff changeset

166 results of a search without affecting how the results are scored

26e78fe6e8c4 "planemo upload commit c699937486c35866861690329de38ec1a5d9f783"

shellac

parents:

diff changeset

167 and sorted. You use `filterQuery` in conjunction with the `query`

26e78fe6e8c4 "planemo upload commit c699937486c35866861690329de38ec1a5d9f783"

shellac

parents:

diff changeset

168 parameter to filter the documents that match the constraints

26e78fe6e8c4 "planemo upload commit c699937486c35866861690329de38ec1a5d9f783"

shellac

parents:

diff changeset

169 specified in the `query` parameter. Specifying a filter controls

26e78fe6e8c4 "planemo upload commit c699937486c35866861690329de38ec1a5d9f783"

shellac

parents:

diff changeset

170 only which matching documents are included in the results, it has

26e78fe6e8c4 "planemo upload commit c699937486c35866861690329de38ec1a5d9f783"

shellac

parents:

diff changeset

171 no effect on how they are scored and sorted. The `filterQuery`

26e78fe6e8c4 "planemo upload commit c699937486c35866861690329de38ec1a5d9f783"

shellac

parents:

diff changeset

172 parameter supports the full structured query syntax.

26e78fe6e8c4 "planemo upload commit c699937486c35866861690329de38ec1a5d9f783"

shellac

parents:

diff changeset

173 For more information about using filters, see `Filtering Matching

26e78fe6e8c4 "planemo upload commit c699937486c35866861690329de38ec1a5d9f783"

shellac

parents:

diff changeset

174 Documents`_ in the Amazon CloudSearch Developer Guide .

26e78fe6e8c4 "planemo upload commit c699937486c35866861690329de38ec1a5d9f783"

shellac

parents:

diff changeset

175

26e78fe6e8c4 "planemo upload commit c699937486c35866861690329de38ec1a5d9f783"

shellac

parents:

diff changeset

176 :type highlight: string

26e78fe6e8c4 "planemo upload commit c699937486c35866861690329de38ec1a5d9f783"

shellac

parents:

diff changeset

177 :param highlight: Retrieves highlights for matches in the specified

26e78fe6e8c4 "planemo upload commit c699937486c35866861690329de38ec1a5d9f783"

shellac

parents:

diff changeset

178 `text` or `text-array` fields. Each specified field must be

26e78fe6e8c4 "planemo upload commit c699937486c35866861690329de38ec1a5d9f783"

shellac

parents:

diff changeset

179 highlight enabled in the domain configuration. The fields and

26e78fe6e8c4 "planemo upload commit c699937486c35866861690329de38ec1a5d9f783"

shellac

parents:

diff changeset

180 options are specified in JSON using the form `{"FIELD":{"OPTION":VA

26e78fe6e8c4 "planemo upload commit c699937486c35866861690329de38ec1a5d9f783"

shellac

parents:

diff changeset

181 LUE,"OPTION:"STRING"},"FIELD":{"OPTION":VALUE,"OPTION":"STRING"}}`.

26e78fe6e8c4 "planemo upload commit c699937486c35866861690329de38ec1a5d9f783"

shellac

parents:

diff changeset

182 You can specify the following highlight options:

26e78fe6e8c4 "planemo upload commit c699937486c35866861690329de38ec1a5d9f783"

shellac

parents:

diff changeset

183

26e78fe6e8c4 "planemo upload commit c699937486c35866861690329de38ec1a5d9f783"

shellac

parents:

diff changeset

184

26e78fe6e8c4 "planemo upload commit c699937486c35866861690329de38ec1a5d9f783"

shellac

parents:

diff changeset

185 + `format`: specifies the format of the data in the text field: `text`

26e78fe6e8c4 "planemo upload commit c699937486c35866861690329de38ec1a5d9f783"

shellac

parents:

diff changeset

186 or `html`. When data is returned as HTML, all non-alphanumeric

26e78fe6e8c4 "planemo upload commit c699937486c35866861690329de38ec1a5d9f783"

shellac

parents:

diff changeset

187 characters are encoded. The default is `html`.

26e78fe6e8c4 "planemo upload commit c699937486c35866861690329de38ec1a5d9f783"

shellac

parents:

diff changeset

188 + `max_phrases`: specifies the maximum number of occurrences of the

26e78fe6e8c4 "planemo upload commit c699937486c35866861690329de38ec1a5d9f783"

shellac

parents:

diff changeset

189 search term(s) you want to highlight. By default, the first

26e78fe6e8c4 "planemo upload commit c699937486c35866861690329de38ec1a5d9f783"

shellac

parents:

diff changeset

190 occurrence is highlighted.

26e78fe6e8c4 "planemo upload commit c699937486c35866861690329de38ec1a5d9f783"

shellac

parents:

diff changeset

191 + `pre_tag`: specifies the string to prepend to an occurrence of a

26e78fe6e8c4 "planemo upload commit c699937486c35866861690329de38ec1a5d9f783"

shellac

parents:

diff changeset

192 search term. The default for HTML highlights is `<em>`. The

26e78fe6e8c4 "planemo upload commit c699937486c35866861690329de38ec1a5d9f783"

shellac

parents:

diff changeset

193 default for text highlights is `*`.

26e78fe6e8c4 "planemo upload commit c699937486c35866861690329de38ec1a5d9f783"

shellac

parents:

diff changeset

194 + `post_tag`: specifies the string to append to an occurrence of a

26e78fe6e8c4 "planemo upload commit c699937486c35866861690329de38ec1a5d9f783"

shellac

parents:

diff changeset

195 search term. The default for HTML highlights is `</em>`. The

26e78fe6e8c4 "planemo upload commit c699937486c35866861690329de38ec1a5d9f783"

shellac

parents:

diff changeset

196 default for text highlights is `*`.

26e78fe6e8c4 "planemo upload commit c699937486c35866861690329de38ec1a5d9f783"

shellac

parents:

diff changeset

197

26e78fe6e8c4 "planemo upload commit c699937486c35866861690329de38ec1a5d9f783"

shellac

parents:

diff changeset

198

26e78fe6e8c4 "planemo upload commit c699937486c35866861690329de38ec1a5d9f783"

shellac

parents:

diff changeset

199 If no highlight options are specified for a field, the returned field

26e78fe6e8c4 "planemo upload commit c699937486c35866861690329de38ec1a5d9f783"

shellac

parents:

diff changeset

200 text is treated as HTML and the first match is highlighted with

26e78fe6e8c4 "planemo upload commit c699937486c35866861690329de38ec1a5d9f783"

shellac

parents:

diff changeset

201 emphasis tags: `<em>search-term</em>`.

26e78fe6e8c4 "planemo upload commit c699937486c35866861690329de38ec1a5d9f783"

shellac

parents:

diff changeset

202

26e78fe6e8c4 "planemo upload commit c699937486c35866861690329de38ec1a5d9f783"

shellac

parents:

diff changeset

203 :type partial: boolean

26e78fe6e8c4 "planemo upload commit c699937486c35866861690329de38ec1a5d9f783"

shellac

parents:

diff changeset

204 :param partial: Enables partial results to be returned if one or more

26e78fe6e8c4 "planemo upload commit c699937486c35866861690329de38ec1a5d9f783"

shellac

parents:

diff changeset

205 index partitions are unavailable. When your search index is

26e78fe6e8c4 "planemo upload commit c699937486c35866861690329de38ec1a5d9f783"

shellac

parents:

diff changeset

206 partitioned across multiple search instances, by default Amazon

26e78fe6e8c4 "planemo upload commit c699937486c35866861690329de38ec1a5d9f783"

shellac

parents:

diff changeset

207 CloudSearch only returns results if every partition can be queried.

26e78fe6e8c4 "planemo upload commit c699937486c35866861690329de38ec1a5d9f783"

shellac

parents:

diff changeset

208 This means that the failure of a single search instance can result

26e78fe6e8c4 "planemo upload commit c699937486c35866861690329de38ec1a5d9f783"

shellac

parents:

diff changeset

209 in 5xx (internal server) errors. When you enable partial results,

26e78fe6e8c4 "planemo upload commit c699937486c35866861690329de38ec1a5d9f783"

shellac

parents:

diff changeset

210 Amazon CloudSearch returns whatever results are available and

26e78fe6e8c4 "planemo upload commit c699937486c35866861690329de38ec1a5d9f783"

shellac

parents:

diff changeset

211 includes the percentage of documents searched in the search results

26e78fe6e8c4 "planemo upload commit c699937486c35866861690329de38ec1a5d9f783"

shellac

parents:

diff changeset

212 (percent-searched). This enables you to more gracefully degrade

26e78fe6e8c4 "planemo upload commit c699937486c35866861690329de38ec1a5d9f783"

shellac

parents:

diff changeset

213 your users' search experience. For example, rather than displaying

26e78fe6e8c4 "planemo upload commit c699937486c35866861690329de38ec1a5d9f783"

shellac

parents:

diff changeset

214 no results, you could display the partial results and a message

26e78fe6e8c4 "planemo upload commit c699937486c35866861690329de38ec1a5d9f783"

shellac

parents:

diff changeset

215 indicating that the results might be incomplete due to a temporary

26e78fe6e8c4 "planemo upload commit c699937486c35866861690329de38ec1a5d9f783"

shellac

parents:

diff changeset

216 system outage.

26e78fe6e8c4 "planemo upload commit c699937486c35866861690329de38ec1a5d9f783"

shellac

parents:

diff changeset

217

26e78fe6e8c4 "planemo upload commit c699937486c35866861690329de38ec1a5d9f783"

shellac

parents:

diff changeset

218 :type query: string

26e78fe6e8c4 "planemo upload commit c699937486c35866861690329de38ec1a5d9f783"

shellac

parents:

diff changeset

219 :param query: Specifies the search criteria for the request. How you

26e78fe6e8c4 "planemo upload commit c699937486c35866861690329de38ec1a5d9f783"

shellac

parents:

diff changeset

220 specify the search criteria depends on the query parser used for

26e78fe6e8c4 "planemo upload commit c699937486c35866861690329de38ec1a5d9f783"

shellac

parents:

diff changeset

221 the request and the parser options specified in the `queryOptions`

26e78fe6e8c4 "planemo upload commit c699937486c35866861690329de38ec1a5d9f783"

shellac

parents:

diff changeset

222 parameter. By default, the `simple` query parser is used to process

26e78fe6e8c4 "planemo upload commit c699937486c35866861690329de38ec1a5d9f783"

shellac

parents:

diff changeset

223 requests. To use the `structured`, `lucene`, or `dismax` query

26e78fe6e8c4 "planemo upload commit c699937486c35866861690329de38ec1a5d9f783"

shellac

parents:

diff changeset

224 parser, you must also specify the `queryParser` parameter.

26e78fe6e8c4 "planemo upload commit c699937486c35866861690329de38ec1a5d9f783"

shellac

parents:

diff changeset

225 For more information about specifying search criteria, see `Searching

26e78fe6e8c4 "planemo upload commit c699937486c35866861690329de38ec1a5d9f783"

shellac

parents:

diff changeset

226 Your Data`_ in the Amazon CloudSearch Developer Guide .

26e78fe6e8c4 "planemo upload commit c699937486c35866861690329de38ec1a5d9f783"

shellac

parents:

diff changeset

227

26e78fe6e8c4 "planemo upload commit c699937486c35866861690329de38ec1a5d9f783"

shellac

parents:

diff changeset

228 :type query_options: string

26e78fe6e8c4 "planemo upload commit c699937486c35866861690329de38ec1a5d9f783"

shellac

parents:

diff changeset

229 :param query_options:

26e78fe6e8c4 "planemo upload commit c699937486c35866861690329de38ec1a5d9f783"

shellac

parents:

diff changeset

230 Configures options for the query parser specified in the `queryParser`

26e78fe6e8c4 "planemo upload commit c699937486c35866861690329de38ec1a5d9f783"

shellac

parents:

diff changeset

231 parameter.

26e78fe6e8c4 "planemo upload commit c699937486c35866861690329de38ec1a5d9f783"

shellac

parents:

diff changeset

232

26e78fe6e8c4 "planemo upload commit c699937486c35866861690329de38ec1a5d9f783"

shellac

parents:

diff changeset

233 The options you can configure vary according to which parser you use:

26e78fe6e8c4 "planemo upload commit c699937486c35866861690329de38ec1a5d9f783"

shellac

parents:

diff changeset

234

26e78fe6e8c4 "planemo upload commit c699937486c35866861690329de38ec1a5d9f783"

shellac

parents:

diff changeset

235

26e78fe6e8c4 "planemo upload commit c699937486c35866861690329de38ec1a5d9f783"

shellac

parents:

diff changeset

236 + `defaultOperator`: The default operator used to combine individual

26e78fe6e8c4 "planemo upload commit c699937486c35866861690329de38ec1a5d9f783"

shellac

parents:

diff changeset

237 terms in the search string. For example: `defaultOperator: 'or'`.

26e78fe6e8c4 "planemo upload commit c699937486c35866861690329de38ec1a5d9f783"

shellac

parents:

diff changeset

238 For the `dismax` parser, you specify a percentage that represents

26e78fe6e8c4 "planemo upload commit c699937486c35866861690329de38ec1a5d9f783"

shellac

parents:

diff changeset

239 the percentage of terms in the search string (rounded down) that

26e78fe6e8c4 "planemo upload commit c699937486c35866861690329de38ec1a5d9f783"

shellac

parents:

diff changeset

240 must match, rather than a default operator. A value of `0%` is the

26e78fe6e8c4 "planemo upload commit c699937486c35866861690329de38ec1a5d9f783"

shellac

parents:

diff changeset

241 equivalent to OR, and a value of `100%` is equivalent to AND. The

26e78fe6e8c4 "planemo upload commit c699937486c35866861690329de38ec1a5d9f783"

shellac

parents:

diff changeset

242 percentage must be specified as a value in the range 0-100 followed

26e78fe6e8c4 "planemo upload commit c699937486c35866861690329de38ec1a5d9f783"

shellac

parents:

diff changeset

243 by the percent (%) symbol. For example, `defaultOperator: 50%`.

26e78fe6e8c4 "planemo upload commit c699937486c35866861690329de38ec1a5d9f783"

shellac

parents:

diff changeset

244 Valid values: `and`, `or`, a percentage in the range 0%-100% (

26e78fe6e8c4 "planemo upload commit c699937486c35866861690329de38ec1a5d9f783"

shellac

parents:

diff changeset

245 `dismax`). Default: `and` ( `simple`, `structured`, `lucene`) or

26e78fe6e8c4 "planemo upload commit c699937486c35866861690329de38ec1a5d9f783"

shellac

parents:

diff changeset

246 `100` ( `dismax`). Valid for: `simple`, `structured`, `lucene`, and

26e78fe6e8c4 "planemo upload commit c699937486c35866861690329de38ec1a5d9f783"

shellac

parents:

diff changeset

247 `dismax`.

26e78fe6e8c4 "planemo upload commit c699937486c35866861690329de38ec1a5d9f783"

shellac

parents:

diff changeset

248 + `fields`: An array of the fields to search when no fields are

26e78fe6e8c4 "planemo upload commit c699937486c35866861690329de38ec1a5d9f783"

shellac

parents:

diff changeset

249 specified in a search. If no fields are specified in a search and

26e78fe6e8c4 "planemo upload commit c699937486c35866861690329de38ec1a5d9f783"

shellac

parents:

diff changeset

250 this option is not specified, all text and text-array fields are

26e78fe6e8c4 "planemo upload commit c699937486c35866861690329de38ec1a5d9f783"

shellac

parents:

diff changeset

251 searched. You can specify a weight for each field to control the

26e78fe6e8c4 "planemo upload commit c699937486c35866861690329de38ec1a5d9f783"

shellac

parents:

diff changeset

252 relative importance of each field when Amazon CloudSearch

26e78fe6e8c4 "planemo upload commit c699937486c35866861690329de38ec1a5d9f783"

shellac

parents:

diff changeset

253 calculates relevance scores. To specify a field weight, append a

26e78fe6e8c4 "planemo upload commit c699937486c35866861690329de38ec1a5d9f783"

shellac

parents:

diff changeset

254 caret ( `^`) symbol and the weight to the field name. For example,

26e78fe6e8c4 "planemo upload commit c699937486c35866861690329de38ec1a5d9f783"

shellac

parents:

diff changeset

255 to boost the importance of the `title` field over the `description`

26e78fe6e8c4 "planemo upload commit c699937486c35866861690329de38ec1a5d9f783"

shellac

parents:

diff changeset

256 field you could specify: `"fields":["title^5","description"]`.

26e78fe6e8c4 "planemo upload commit c699937486c35866861690329de38ec1a5d9f783"

shellac

parents:

diff changeset

257 Valid values: The name of any configured field and an optional

26e78fe6e8c4 "planemo upload commit c699937486c35866861690329de38ec1a5d9f783"

shellac

parents:

diff changeset

258 numeric value greater than zero. Default: All `text` and `text-

26e78fe6e8c4 "planemo upload commit c699937486c35866861690329de38ec1a5d9f783"

shellac

parents:

diff changeset

259 array` fields. Valid for: `simple`, `structured`, `lucene`, and

26e78fe6e8c4 "planemo upload commit c699937486c35866861690329de38ec1a5d9f783"

shellac

parents:

diff changeset

260 `dismax`.

26e78fe6e8c4 "planemo upload commit c699937486c35866861690329de38ec1a5d9f783"

shellac

parents:

diff changeset

261 + `operators`: An array of the operators or special characters you want

26e78fe6e8c4 "planemo upload commit c699937486c35866861690329de38ec1a5d9f783"

shellac

parents:

diff changeset

262 to disable for the simple query parser. If you disable the `and`,

26e78fe6e8c4 "planemo upload commit c699937486c35866861690329de38ec1a5d9f783"

shellac

parents:

diff changeset

263 `or`, or `not` operators, the corresponding operators ( `+`, `|`,

26e78fe6e8c4 "planemo upload commit c699937486c35866861690329de38ec1a5d9f783"

shellac

parents:

diff changeset

264 `-`) have no special meaning and are dropped from the search

26e78fe6e8c4 "planemo upload commit c699937486c35866861690329de38ec1a5d9f783"

shellac

parents:

diff changeset

265 string. Similarly, disabling `prefix` disables the wildcard

26e78fe6e8c4 "planemo upload commit c699937486c35866861690329de38ec1a5d9f783"

shellac

parents:

diff changeset

266 operator ( `*`) and disabling `phrase` disables the ability to

26e78fe6e8c4 "planemo upload commit c699937486c35866861690329de38ec1a5d9f783"

shellac

parents:

diff changeset

267 search for phrases by enclosing phrases in double quotes. Disabling

26e78fe6e8c4 "planemo upload commit c699937486c35866861690329de38ec1a5d9f783"

shellac

parents:

diff changeset

268 precedence disables the ability to control order of precedence

26e78fe6e8c4 "planemo upload commit c699937486c35866861690329de38ec1a5d9f783"

shellac

parents:

diff changeset

269 using parentheses. Disabling `near` disables the ability to use the

26e78fe6e8c4 "planemo upload commit c699937486c35866861690329de38ec1a5d9f783"

shellac

parents:

diff changeset

270 ~ operator to perform a sloppy phrase search. Disabling the `fuzzy`

26e78fe6e8c4 "planemo upload commit c699937486c35866861690329de38ec1a5d9f783"

shellac

parents:

diff changeset

271 operator disables the ability to use the ~ operator to perform a

26e78fe6e8c4 "planemo upload commit c699937486c35866861690329de38ec1a5d9f783"

shellac

parents:

diff changeset

272 fuzzy search. `escape` disables the ability to use a backslash (

26e78fe6e8c4 "planemo upload commit c699937486c35866861690329de38ec1a5d9f783"

shellac

parents:

diff changeset

273 `\`) to escape special characters within the search string.

26e78fe6e8c4 "planemo upload commit c699937486c35866861690329de38ec1a5d9f783"

shellac

parents:

diff changeset

274 Disabling whitespace is an advanced option that prevents the parser

26e78fe6e8c4 "planemo upload commit c699937486c35866861690329de38ec1a5d9f783"

shellac

parents:

diff changeset

275 from tokenizing on whitespace, which can be useful for Vietnamese.

26e78fe6e8c4 "planemo upload commit c699937486c35866861690329de38ec1a5d9f783"

shellac

parents:

diff changeset

276 (It prevents Vietnamese words from being split incorrectly.) For

26e78fe6e8c4 "planemo upload commit c699937486c35866861690329de38ec1a5d9f783"

shellac

parents:

diff changeset

277 example, you could disable all operators other than the phrase

26e78fe6e8c4 "planemo upload commit c699937486c35866861690329de38ec1a5d9f783"

shellac

parents:

diff changeset

278 operator to support just simple term and phrase queries:

26e78fe6e8c4 "planemo upload commit c699937486c35866861690329de38ec1a5d9f783"

shellac

parents:

diff changeset

279 `"operators":["and","not","or", "prefix"]`. Valid values: `and`,

26e78fe6e8c4 "planemo upload commit c699937486c35866861690329de38ec1a5d9f783"

shellac

parents:

diff changeset

280 `escape`, `fuzzy`, `near`, `not`, `or`, `phrase`, `precedence`,

26e78fe6e8c4 "planemo upload commit c699937486c35866861690329de38ec1a5d9f783"

shellac

parents:

diff changeset

281 `prefix`, `whitespace`. Default: All operators and special

26e78fe6e8c4 "planemo upload commit c699937486c35866861690329de38ec1a5d9f783"

shellac

parents:

diff changeset

282 characters are enabled. Valid for: `simple`.

26e78fe6e8c4 "planemo upload commit c699937486c35866861690329de38ec1a5d9f783"

shellac

parents:

diff changeset

283 + `phraseFields`: An array of the `text` or `text-array` fields you

26e78fe6e8c4 "planemo upload commit c699937486c35866861690329de38ec1a5d9f783"

shellac

parents:

diff changeset

284 want to use for phrase searches. When the terms in the search

26e78fe6e8c4 "planemo upload commit c699937486c35866861690329de38ec1a5d9f783"

shellac

parents:

diff changeset

285 string appear in close proximity within a field, the field scores

26e78fe6e8c4 "planemo upload commit c699937486c35866861690329de38ec1a5d9f783"

shellac

parents:

diff changeset

286 higher. You can specify a weight for each field to boost that

26e78fe6e8c4 "planemo upload commit c699937486c35866861690329de38ec1a5d9f783"

shellac

parents:

diff changeset

287 score. The `phraseSlop` option controls how much the matches can

26e78fe6e8c4 "planemo upload commit c699937486c35866861690329de38ec1a5d9f783"

shellac

parents:

diff changeset

288 deviate from the search string and still be boosted. To specify a

26e78fe6e8c4 "planemo upload commit c699937486c35866861690329de38ec1a5d9f783"

shellac

parents:

diff changeset

289 field weight, append a caret ( `^`) symbol and the weight to the

26e78fe6e8c4 "planemo upload commit c699937486c35866861690329de38ec1a5d9f783"

shellac

parents:

diff changeset

290 field name. For example, to boost phrase matches in the `title`

26e78fe6e8c4 "planemo upload commit c699937486c35866861690329de38ec1a5d9f783"

shellac

parents:

diff changeset

291 field over the `abstract` field, you could specify:

26e78fe6e8c4 "planemo upload commit c699937486c35866861690329de38ec1a5d9f783"

shellac

parents:

diff changeset

292 `"phraseFields":["title^3", "plot"]` Valid values: The name of any

26e78fe6e8c4 "planemo upload commit c699937486c35866861690329de38ec1a5d9f783"

shellac

parents:

diff changeset

293 `text` or `text-array` field and an optional numeric value greater

26e78fe6e8c4 "planemo upload commit c699937486c35866861690329de38ec1a5d9f783"

shellac

parents:

diff changeset

294 than zero. Default: No fields. If you don't specify any fields with

26e78fe6e8c4 "planemo upload commit c699937486c35866861690329de38ec1a5d9f783"

shellac

parents:

diff changeset

295 `phraseFields`, proximity scoring is disabled even if `phraseSlop`

26e78fe6e8c4 "planemo upload commit c699937486c35866861690329de38ec1a5d9f783"

shellac

parents:

diff changeset

296 is specified. Valid for: `dismax`.

26e78fe6e8c4 "planemo upload commit c699937486c35866861690329de38ec1a5d9f783"

shellac

parents:

diff changeset

297 + `phraseSlop`: An integer value that specifies how much matches can

26e78fe6e8c4 "planemo upload commit c699937486c35866861690329de38ec1a5d9f783"

shellac

parents:

diff changeset

298 deviate from the search phrase and still be boosted according to

26e78fe6e8c4 "planemo upload commit c699937486c35866861690329de38ec1a5d9f783"

shellac

parents:

diff changeset

299 the weights specified in the `phraseFields` option; for example,

26e78fe6e8c4 "planemo upload commit c699937486c35866861690329de38ec1a5d9f783"

shellac

parents:

diff changeset

300 `phraseSlop: 2`. You must also specify `phraseFields` to enable

26e78fe6e8c4 "planemo upload commit c699937486c35866861690329de38ec1a5d9f783"

shellac

parents:

diff changeset

301 proximity scoring. Valid values: positive integers. Default: 0.

26e78fe6e8c4 "planemo upload commit c699937486c35866861690329de38ec1a5d9f783"

shellac

parents:

diff changeset

302 Valid for: `dismax`.

26e78fe6e8c4 "planemo upload commit c699937486c35866861690329de38ec1a5d9f783"

shellac

parents:

diff changeset

303 + `explicitPhraseSlop`: An integer value that specifies how much a

26e78fe6e8c4 "planemo upload commit c699937486c35866861690329de38ec1a5d9f783"

shellac

parents:

diff changeset

304 match can deviate from the search phrase when the phrase is

26e78fe6e8c4 "planemo upload commit c699937486c35866861690329de38ec1a5d9f783"

shellac

parents:

diff changeset

305 enclosed in double quotes in the search string. (Phrases that

26e78fe6e8c4 "planemo upload commit c699937486c35866861690329de38ec1a5d9f783"

shellac

parents:

diff changeset

306 exceed this proximity distance are not considered a match.) For

26e78fe6e8c4 "planemo upload commit c699937486c35866861690329de38ec1a5d9f783"

shellac

parents:

diff changeset

307 example, to specify a slop of three for dismax phrase queries, you

26e78fe6e8c4 "planemo upload commit c699937486c35866861690329de38ec1a5d9f783"

shellac

parents:

diff changeset

308 would specify `"explicitPhraseSlop":3`. Valid values: positive

26e78fe6e8c4 "planemo upload commit c699937486c35866861690329de38ec1a5d9f783"

shellac

parents:

diff changeset

309 integers. Default: 0. Valid for: `dismax`.

26e78fe6e8c4 "planemo upload commit c699937486c35866861690329de38ec1a5d9f783"

shellac

parents:

diff changeset

310 + `tieBreaker`: When a term in the search string is found in a

26e78fe6e8c4 "planemo upload commit c699937486c35866861690329de38ec1a5d9f783"

shellac

parents:

diff changeset

311 document's field, a score is calculated for that field based on how

26e78fe6e8c4 "planemo upload commit c699937486c35866861690329de38ec1a5d9f783"

shellac

parents:

diff changeset

312 common the word is in that field compared to other documents. If

26e78fe6e8c4 "planemo upload commit c699937486c35866861690329de38ec1a5d9f783"

shellac

parents:

diff changeset

313 the term occurs in multiple fields within a document, by default

26e78fe6e8c4 "planemo upload commit c699937486c35866861690329de38ec1a5d9f783"

shellac

parents:

diff changeset

314 only the highest scoring field contributes to the document's

26e78fe6e8c4 "planemo upload commit c699937486c35866861690329de38ec1a5d9f783"

shellac

parents:

diff changeset

315 overall score. You can specify a `tieBreaker` value to enable the

26e78fe6e8c4 "planemo upload commit c699937486c35866861690329de38ec1a5d9f783"

shellac

parents:

diff changeset

316 matches in lower-scoring fields to contribute to the document's

26e78fe6e8c4 "planemo upload commit c699937486c35866861690329de38ec1a5d9f783"

shellac

parents:

diff changeset

317 score. That way, if two documents have the same max field score for

26e78fe6e8c4 "planemo upload commit c699937486c35866861690329de38ec1a5d9f783"

shellac

parents:

diff changeset

318 a particular term, the score for the document that has matches in

26e78fe6e8c4 "planemo upload commit c699937486c35866861690329de38ec1a5d9f783"

shellac

parents:

diff changeset

319 more fields will be higher. The formula for calculating the score

26e78fe6e8c4 "planemo upload commit c699937486c35866861690329de38ec1a5d9f783"

shellac

parents:

diff changeset

320 with a tieBreaker is `(max field score) + (tieBreaker) * (sum of

26e78fe6e8c4 "planemo upload commit c699937486c35866861690329de38ec1a5d9f783"

shellac

parents:

diff changeset

321 the scores for the rest of the matching fields)`. Set `tieBreaker`

26e78fe6e8c4 "planemo upload commit c699937486c35866861690329de38ec1a5d9f783"

shellac

parents:

diff changeset

322 to 0 to disregard all but the highest scoring field (pure max):

26e78fe6e8c4 "planemo upload commit c699937486c35866861690329de38ec1a5d9f783"

shellac

parents:

diff changeset

323 `"tieBreaker":0`. Set to 1 to sum the scores from all fields (pure

26e78fe6e8c4 "planemo upload commit c699937486c35866861690329de38ec1a5d9f783"

shellac

parents:

diff changeset

324 sum): `"tieBreaker":1`. Valid values: 0.0 to 1.0. Default: 0.0.

26e78fe6e8c4 "planemo upload commit c699937486c35866861690329de38ec1a5d9f783"

shellac

parents:

diff changeset

325 Valid for: `dismax`.

26e78fe6e8c4 "planemo upload commit c699937486c35866861690329de38ec1a5d9f783"

shellac

parents:

diff changeset

326

26e78fe6e8c4 "planemo upload commit c699937486c35866861690329de38ec1a5d9f783"

shellac

parents:

diff changeset

327 :type query_parser: string

26e78fe6e8c4 "planemo upload commit c699937486c35866861690329de38ec1a5d9f783"

shellac

parents:

diff changeset

328 :param query_parser:

26e78fe6e8c4 "planemo upload commit c699937486c35866861690329de38ec1a5d9f783"

shellac

parents:

diff changeset

329 Specifies which query parser to use to process the request. If

26e78fe6e8c4 "planemo upload commit c699937486c35866861690329de38ec1a5d9f783"

shellac

parents:

diff changeset

330 `queryParser` is not specified, Amazon CloudSearch uses the

26e78fe6e8c4 "planemo upload commit c699937486c35866861690329de38ec1a5d9f783"

shellac

parents:

diff changeset

331 `simple` query parser.

26e78fe6e8c4 "planemo upload commit c699937486c35866861690329de38ec1a5d9f783"

shellac

parents:

diff changeset

332

26e78fe6e8c4 "planemo upload commit c699937486c35866861690329de38ec1a5d9f783"

shellac

parents:

diff changeset

333 Amazon CloudSearch supports four query parsers:

26e78fe6e8c4 "planemo upload commit c699937486c35866861690329de38ec1a5d9f783"

shellac

parents:

diff changeset

334

26e78fe6e8c4 "planemo upload commit c699937486c35866861690329de38ec1a5d9f783"

shellac

parents:

diff changeset

335

26e78fe6e8c4 "planemo upload commit c699937486c35866861690329de38ec1a5d9f783"

shellac

parents:

diff changeset

336 + `simple`: perform simple searches of `text` and `text-array` fields.

26e78fe6e8c4 "planemo upload commit c699937486c35866861690329de38ec1a5d9f783"

shellac

parents:

diff changeset

337 By default, the `simple` query parser searches all `text` and

26e78fe6e8c4 "planemo upload commit c699937486c35866861690329de38ec1a5d9f783"

shellac

parents:

diff changeset

338 `text-array` fields. You can specify which fields to search by with

26e78fe6e8c4 "planemo upload commit c699937486c35866861690329de38ec1a5d9f783"

shellac

parents:

diff changeset

339 the `queryOptions` parameter. If you prefix a search term with a

26e78fe6e8c4 "planemo upload commit c699937486c35866861690329de38ec1a5d9f783"

shellac

parents:

diff changeset

340 plus sign (+) documents must contain the term to be considered a

26e78fe6e8c4 "planemo upload commit c699937486c35866861690329de38ec1a5d9f783"

shellac

parents:

diff changeset

341 match. (This is the default, unless you configure the default

26e78fe6e8c4 "planemo upload commit c699937486c35866861690329de38ec1a5d9f783"

shellac

parents:

diff changeset

342 operator with the `queryOptions` parameter.) You can use the `-`

26e78fe6e8c4 "planemo upload commit c699937486c35866861690329de38ec1a5d9f783"

shellac

parents:

diff changeset

343 (NOT), `|` (OR), and `*` (wildcard) operators to exclude particular

26e78fe6e8c4 "planemo upload commit c699937486c35866861690329de38ec1a5d9f783"

shellac

parents:

diff changeset

344 terms, find results that match any of the specified terms, or

26e78fe6e8c4 "planemo upload commit c699937486c35866861690329de38ec1a5d9f783"

shellac

parents:

diff changeset

345 search for a prefix. To search for a phrase rather than individual

26e78fe6e8c4 "planemo upload commit c699937486c35866861690329de38ec1a5d9f783"

shellac

parents:

diff changeset

346 terms, enclose the phrase in double quotes. For more information,

26e78fe6e8c4 "planemo upload commit c699937486c35866861690329de38ec1a5d9f783"

shellac

parents:

diff changeset

347 see `Searching for Text`_ in the Amazon CloudSearch Developer Guide

26e78fe6e8c4 "planemo upload commit c699937486c35866861690329de38ec1a5d9f783"

shellac

parents:

diff changeset

348 .

26e78fe6e8c4 "planemo upload commit c699937486c35866861690329de38ec1a5d9f783"

shellac

parents:

diff changeset

349 + `structured`: perform advanced searches by combining multiple

26e78fe6e8c4 "planemo upload commit c699937486c35866861690329de38ec1a5d9f783"

shellac

parents:

diff changeset

350 expressions to define the search criteria. You can also search

26e78fe6e8c4 "planemo upload commit c699937486c35866861690329de38ec1a5d9f783"

shellac

parents:

diff changeset

351 within particular fields, search for values and ranges of values,

26e78fe6e8c4 "planemo upload commit c699937486c35866861690329de38ec1a5d9f783"

shellac

parents:

diff changeset

352 and use advanced options such as term boosting, `matchall`, and

26e78fe6e8c4 "planemo upload commit c699937486c35866861690329de38ec1a5d9f783"

shellac

parents:

diff changeset

353 `near`. For more information, see `Constructing Compound Queries`_

26e78fe6e8c4 "planemo upload commit c699937486c35866861690329de38ec1a5d9f783"

shellac

parents:

diff changeset

354 in the Amazon CloudSearch Developer Guide .

26e78fe6e8c4 "planemo upload commit c699937486c35866861690329de38ec1a5d9f783"

shellac

parents:

diff changeset

355 + `lucene`: search using the Apache Lucene query parser syntax. For

26e78fe6e8c4 "planemo upload commit c699937486c35866861690329de38ec1a5d9f783"

shellac

parents:

diff changeset

356 more information, see `Apache Lucene Query Parser Syntax`_.

26e78fe6e8c4 "planemo upload commit c699937486c35866861690329de38ec1a5d9f783"

shellac

parents:

diff changeset

357 + `dismax`: search using the simplified subset of the Apache Lucene

26e78fe6e8c4 "planemo upload commit c699937486c35866861690329de38ec1a5d9f783"

shellac

parents:

diff changeset

358 query parser syntax defined by the DisMax query parser. For more

26e78fe6e8c4 "planemo upload commit c699937486c35866861690329de38ec1a5d9f783"

shellac

parents:

diff changeset

359 information, see `DisMax Query Parser Syntax`_.

26e78fe6e8c4 "planemo upload commit c699937486c35866861690329de38ec1a5d9f783"

shellac

parents:

diff changeset

360

26e78fe6e8c4 "planemo upload commit c699937486c35866861690329de38ec1a5d9f783"

shellac

parents:

diff changeset

361 :type ret: string

26e78fe6e8c4 "planemo upload commit c699937486c35866861690329de38ec1a5d9f783"

shellac

parents:

diff changeset

362 :param ret: Specifies the field and expression values to include in

26e78fe6e8c4 "planemo upload commit c699937486c35866861690329de38ec1a5d9f783"

shellac

parents:

diff changeset

363 the response. Multiple fields or expressions are specified as a

26e78fe6e8c4 "planemo upload commit c699937486c35866861690329de38ec1a5d9f783"

shellac

parents:

diff changeset

364 comma-separated list. By default, a search response includes all

26e78fe6e8c4 "planemo upload commit c699937486c35866861690329de38ec1a5d9f783"

shellac

parents:

diff changeset

365 return enabled fields ( `_all_fields`). To return only the document

26e78fe6e8c4 "planemo upload commit c699937486c35866861690329de38ec1a5d9f783"

shellac

parents:

diff changeset

366 IDs for the matching documents, specify `_no_fields`. To retrieve

26e78fe6e8c4 "planemo upload commit c699937486c35866861690329de38ec1a5d9f783"

shellac

parents:

diff changeset

367 the relevance score calculated for each document, specify `_score`.

26e78fe6e8c4 "planemo upload commit c699937486c35866861690329de38ec1a5d9f783"

shellac

parents:

diff changeset

368

26e78fe6e8c4 "planemo upload commit c699937486c35866861690329de38ec1a5d9f783"

shellac

parents:

diff changeset

369 :type size: long

26e78fe6e8c4 "planemo upload commit c699937486c35866861690329de38ec1a5d9f783"

shellac

parents:

diff changeset

370 :param size: Specifies the maximum number of search hits to include in

26e78fe6e8c4 "planemo upload commit c699937486c35866861690329de38ec1a5d9f783"

shellac

parents:

diff changeset

371 the response.

26e78fe6e8c4 "planemo upload commit c699937486c35866861690329de38ec1a5d9f783"

shellac

parents:

diff changeset

372

26e78fe6e8c4 "planemo upload commit c699937486c35866861690329de38ec1a5d9f783"

shellac

parents:

diff changeset

373 :type sort: string

26e78fe6e8c4 "planemo upload commit c699937486c35866861690329de38ec1a5d9f783"

shellac

parents:

diff changeset

374 :param sort: Specifies the fields or custom expressions to use to sort

26e78fe6e8c4 "planemo upload commit c699937486c35866861690329de38ec1a5d9f783"

shellac

parents:

diff changeset

375 the search results. Multiple fields or expressions are specified as

26e78fe6e8c4 "planemo upload commit c699937486c35866861690329de38ec1a5d9f783"

shellac

parents:

diff changeset

376 a comma-separated list. You must specify the sort direction ( `asc`

26e78fe6e8c4 "planemo upload commit c699937486c35866861690329de38ec1a5d9f783"

shellac

parents:

diff changeset

377 or `desc`) for each field; for example, `year desc,title asc`. To

26e78fe6e8c4 "planemo upload commit c699937486c35866861690329de38ec1a5d9f783"

shellac

parents:

diff changeset

378 use a field to sort results, the field must be sort-enabled in the

26e78fe6e8c4 "planemo upload commit c699937486c35866861690329de38ec1a5d9f783"

shellac

parents:

diff changeset

379 domain configuration. Array type fields cannot be used for sorting.

26e78fe6e8c4 "planemo upload commit c699937486c35866861690329de38ec1a5d9f783"

shellac

parents:

diff changeset

380 If no `sort` parameter is specified, results are sorted by their

26e78fe6e8c4 "planemo upload commit c699937486c35866861690329de38ec1a5d9f783"

shellac

parents:

diff changeset

381 default relevance scores in descending order: `_score desc`. You

26e78fe6e8c4 "planemo upload commit c699937486c35866861690329de38ec1a5d9f783"

shellac

parents:

diff changeset

382 can also sort by document ID ( `_id asc`) and version ( `_version

26e78fe6e8c4 "planemo upload commit c699937486c35866861690329de38ec1a5d9f783"

shellac

parents:

diff changeset

383 desc`).

26e78fe6e8c4 "planemo upload commit c699937486c35866861690329de38ec1a5d9f783"

shellac

parents:

diff changeset

384 For more information, see `Sorting Results`_ in the Amazon CloudSearch

26e78fe6e8c4 "planemo upload commit c699937486c35866861690329de38ec1a5d9f783"

shellac

parents:

diff changeset

385 Developer Guide .

26e78fe6e8c4 "planemo upload commit c699937486c35866861690329de38ec1a5d9f783"

shellac

parents:

diff changeset

386

26e78fe6e8c4 "planemo upload commit c699937486c35866861690329de38ec1a5d9f783"

shellac

parents:

diff changeset

387 :type start: long

26e78fe6e8c4 "planemo upload commit c699937486c35866861690329de38ec1a5d9f783"

shellac

parents:

diff changeset

388 :param start: Specifies the offset of the first search hit you want to

26e78fe6e8c4 "planemo upload commit c699937486c35866861690329de38ec1a5d9f783"

shellac

parents:

diff changeset

389 return. Note that the result set is zero-based; the first result is

26e78fe6e8c4 "planemo upload commit c699937486c35866861690329de38ec1a5d9f783"

shellac

parents:

diff changeset

390 at index 0. You can specify either the `start` or `cursor`

26e78fe6e8c4 "planemo upload commit c699937486c35866861690329de38ec1a5d9f783"

shellac

parents:

diff changeset

391 parameter in a request, they are mutually exclusive.

26e78fe6e8c4 "planemo upload commit c699937486c35866861690329de38ec1a5d9f783"

shellac

parents:

diff changeset

392 For more information, see `Paginating Results`_ in the Amazon

26e78fe6e8c4 "planemo upload commit c699937486c35866861690329de38ec1a5d9f783"

shellac

parents:

diff changeset

393 CloudSearch Developer Guide .

26e78fe6e8c4 "planemo upload commit c699937486c35866861690329de38ec1a5d9f783"

shellac

parents:

diff changeset

394

26e78fe6e8c4 "planemo upload commit c699937486c35866861690329de38ec1a5d9f783"

shellac

parents:

diff changeset

395 """

26e78fe6e8c4 "planemo upload commit c699937486c35866861690329de38ec1a5d9f783"

shellac

parents:

diff changeset

396 uri = '/2013-01-01/search'

26e78fe6e8c4 "planemo upload commit c699937486c35866861690329de38ec1a5d9f783"

shellac

parents:

diff changeset

397 params = {}

26e78fe6e8c4 "planemo upload commit c699937486c35866861690329de38ec1a5d9f783"

shellac

parents:

diff changeset

398 headers = {}

26e78fe6e8c4 "planemo upload commit c699937486c35866861690329de38ec1a5d9f783"

shellac

parents:

diff changeset

399 query_params = {}

26e78fe6e8c4 "planemo upload commit c699937486c35866861690329de38ec1a5d9f783"

shellac

parents:

diff changeset

400 if cursor is not None:

26e78fe6e8c4 "planemo upload commit c699937486c35866861690329de38ec1a5d9f783"

shellac

parents:

diff changeset

401 query_params['cursor'] = cursor

26e78fe6e8c4 "planemo upload commit c699937486c35866861690329de38ec1a5d9f783"

shellac

parents:

diff changeset

402 if expr is not None:

26e78fe6e8c4 "planemo upload commit c699937486c35866861690329de38ec1a5d9f783"

shellac

parents:

diff changeset

403 query_params['expr'] = expr

26e78fe6e8c4 "planemo upload commit c699937486c35866861690329de38ec1a5d9f783"

shellac

parents:

diff changeset

404 if facet is not None:

26e78fe6e8c4 "planemo upload commit c699937486c35866861690329de38ec1a5d9f783"

shellac

parents:

diff changeset

405 query_params['facet'] = facet

26e78fe6e8c4 "planemo upload commit c699937486c35866861690329de38ec1a5d9f783"

shellac

parents:

diff changeset

406 if filter_query is not None:

26e78fe6e8c4 "planemo upload commit c699937486c35866861690329de38ec1a5d9f783"

shellac

parents:

diff changeset

407 query_params['fq'] = filter_query

26e78fe6e8c4 "planemo upload commit c699937486c35866861690329de38ec1a5d9f783"

shellac

parents:

diff changeset

408 if highlight is not None:

26e78fe6e8c4 "planemo upload commit c699937486c35866861690329de38ec1a5d9f783"

shellac

parents:

diff changeset

409 query_params['highlight'] = highlight

26e78fe6e8c4 "planemo upload commit c699937486c35866861690329de38ec1a5d9f783"

shellac

parents:

diff changeset

410 if partial is not None:

26e78fe6e8c4 "planemo upload commit c699937486c35866861690329de38ec1a5d9f783"

shellac

parents:

diff changeset

411 query_params['partial'] = partial

26e78fe6e8c4 "planemo upload commit c699937486c35866861690329de38ec1a5d9f783"

shellac

parents:

diff changeset

412 if query is not None:

26e78fe6e8c4 "planemo upload commit c699937486c35866861690329de38ec1a5d9f783"

shellac

parents:

diff changeset

413 query_params['q'] = query

26e78fe6e8c4 "planemo upload commit c699937486c35866861690329de38ec1a5d9f783"

shellac

parents:

diff changeset

414 if query_options is not None:

26e78fe6e8c4 "planemo upload commit c699937486c35866861690329de38ec1a5d9f783"

shellac

parents:

diff changeset

415 query_params['q.options'] = query_options

26e78fe6e8c4 "planemo upload commit c699937486c35866861690329de38ec1a5d9f783"

shellac

parents:

diff changeset

416 if query_parser is not None:

26e78fe6e8c4 "planemo upload commit c699937486c35866861690329de38ec1a5d9f783"

shellac

parents:

diff changeset

417 query_params['q.parser'] = query_parser

26e78fe6e8c4 "planemo upload commit c699937486c35866861690329de38ec1a5d9f783"

shellac

parents:

diff changeset

418 if ret is not None:

26e78fe6e8c4 "planemo upload commit c699937486c35866861690329de38ec1a5d9f783"

shellac

parents:

diff changeset

419 query_params['return'] = ret

26e78fe6e8c4 "planemo upload commit c699937486c35866861690329de38ec1a5d9f783"

shellac

parents:

diff changeset

420 if size is not None:

26e78fe6e8c4 "planemo upload commit c699937486c35866861690329de38ec1a5d9f783"

shellac

parents:

diff changeset

421 query_params['size'] = size

26e78fe6e8c4 "planemo upload commit c699937486c35866861690329de38ec1a5d9f783"

shellac

parents:

diff changeset

422 if sort is not None:

26e78fe6e8c4 "planemo upload commit c699937486c35866861690329de38ec1a5d9f783"

shellac

parents:

diff changeset

423 query_params['sort'] = sort

26e78fe6e8c4 "planemo upload commit c699937486c35866861690329de38ec1a5d9f783"

shellac

parents:

diff changeset

424 if start is not None:

26e78fe6e8c4 "planemo upload commit c699937486c35866861690329de38ec1a5d9f783"

shellac

parents:

diff changeset

425 query_params['start'] = start

26e78fe6e8c4 "planemo upload commit c699937486c35866861690329de38ec1a5d9f783"

shellac

parents:

diff changeset

426 return self.make_request('POST', uri, expected_status=200,

26e78fe6e8c4 "planemo upload commit c699937486c35866861690329de38ec1a5d9f783"

shellac

parents:

diff changeset

427 data=json.dumps(params), headers=headers,

26e78fe6e8c4 "planemo upload commit c699937486c35866861690329de38ec1a5d9f783"

shellac

parents:

diff changeset

428 params=query_params)

26e78fe6e8c4 "planemo upload commit c699937486c35866861690329de38ec1a5d9f783"

shellac

parents:

diff changeset

429

26e78fe6e8c4 "planemo upload commit c699937486c35866861690329de38ec1a5d9f783"

shellac

parents:

diff changeset

430 def suggest(self, query, suggester, size=None):

26e78fe6e8c4 "planemo upload commit c699937486c35866861690329de38ec1a5d9f783"

shellac

parents:

diff changeset

431 """

26e78fe6e8c4 "planemo upload commit c699937486c35866861690329de38ec1a5d9f783"

shellac

parents:

diff changeset

432 Retrieves autocomplete suggestions for a partial query string.

26e78fe6e8c4 "planemo upload commit c699937486c35866861690329de38ec1a5d9f783"

shellac

parents:

diff changeset

433 You can use suggestions enable you to display likely matches

26e78fe6e8c4 "planemo upload commit c699937486c35866861690329de38ec1a5d9f783"

shellac

parents:

diff changeset

434 before users finish typing. In Amazon CloudSearch, suggestions

26e78fe6e8c4 "planemo upload commit c699937486c35866861690329de38ec1a5d9f783"

shellac

parents:

diff changeset

435 are based on the contents of a particular text field. When you

26e78fe6e8c4 "planemo upload commit c699937486c35866861690329de38ec1a5d9f783"

shellac

parents:

diff changeset

436 request suggestions, Amazon CloudSearch finds all of the

26e78fe6e8c4 "planemo upload commit c699937486c35866861690329de38ec1a5d9f783"

shellac

parents:

diff changeset

437 documents whose values in the suggester field start with the

26e78fe6e8c4 "planemo upload commit c699937486c35866861690329de38ec1a5d9f783"

shellac

parents:

diff changeset

438 specified query string. The beginning of the field must match

26e78fe6e8c4 "planemo upload commit c699937486c35866861690329de38ec1a5d9f783"

shellac

parents:

diff changeset

439 the query string to be considered a match.

26e78fe6e8c4 "planemo upload commit c699937486c35866861690329de38ec1a5d9f783"

shellac

parents:

diff changeset

440

26e78fe6e8c4 "planemo upload commit c699937486c35866861690329de38ec1a5d9f783"

shellac

parents:

diff changeset

441 For more information about configuring suggesters and

26e78fe6e8c4 "planemo upload commit c699937486c35866861690329de38ec1a5d9f783"

shellac

parents:

diff changeset

442 retrieving suggestions, see `Getting Suggestions`_ in the

26e78fe6e8c4 "planemo upload commit c699937486c35866861690329de38ec1a5d9f783"

shellac

parents:

diff changeset

443 Amazon CloudSearch Developer Guide .

26e78fe6e8c4 "planemo upload commit c699937486c35866861690329de38ec1a5d9f783"

shellac

parents:

diff changeset

444

26e78fe6e8c4 "planemo upload commit c699937486c35866861690329de38ec1a5d9f783"

shellac

parents:

diff changeset

445 The endpoint for submitting `Suggest` requests is domain-

26e78fe6e8c4 "planemo upload commit c699937486c35866861690329de38ec1a5d9f783"

shellac

parents:

diff changeset

446 specific. You submit suggest requests to a domain's search

26e78fe6e8c4 "planemo upload commit c699937486c35866861690329de38ec1a5d9f783"

shellac

parents:

diff changeset

447 endpoint. To get the search endpoint for your domain, use the

26e78fe6e8c4 "planemo upload commit c699937486c35866861690329de38ec1a5d9f783"

shellac

parents:

diff changeset

448 Amazon CloudSearch configuration service `DescribeDomains`

26e78fe6e8c4 "planemo upload commit c699937486c35866861690329de38ec1a5d9f783"

shellac

parents:

diff changeset

449 action. A domain's endpoints are also displayed on the domain

26e78fe6e8c4 "planemo upload commit c699937486c35866861690329de38ec1a5d9f783"

shellac

parents:

diff changeset

450 dashboard in the Amazon CloudSearch console.

26e78fe6e8c4 "planemo upload commit c699937486c35866861690329de38ec1a5d9f783"

shellac

parents:

diff changeset

451

26e78fe6e8c4 "planemo upload commit c699937486c35866861690329de38ec1a5d9f783"

shellac

parents:

diff changeset

452 :type query: string

26e78fe6e8c4 "planemo upload commit c699937486c35866861690329de38ec1a5d9f783"

shellac

parents:

diff changeset

453 :param query: Specifies the string for which you want to get

26e78fe6e8c4 "planemo upload commit c699937486c35866861690329de38ec1a5d9f783"

shellac

parents:

diff changeset

454 suggestions.

26e78fe6e8c4 "planemo upload commit c699937486c35866861690329de38ec1a5d9f783"

shellac

parents:

diff changeset

455

26e78fe6e8c4 "planemo upload commit c699937486c35866861690329de38ec1a5d9f783"

shellac

parents:

diff changeset

456 :type suggester: string

26e78fe6e8c4 "planemo upload commit c699937486c35866861690329de38ec1a5d9f783"

shellac

parents:

diff changeset

457 :param suggester: Specifies the name of the suggester to use to find

26e78fe6e8c4 "planemo upload commit c699937486c35866861690329de38ec1a5d9f783"

shellac

parents:

diff changeset

458 suggested matches.

26e78fe6e8c4 "planemo upload commit c699937486c35866861690329de38ec1a5d9f783"

shellac

parents:

diff changeset

459

26e78fe6e8c4 "planemo upload commit c699937486c35866861690329de38ec1a5d9f783"

shellac

parents:

diff changeset

460 :type size: long

26e78fe6e8c4 "planemo upload commit c699937486c35866861690329de38ec1a5d9f783"

shellac

parents:

diff changeset

461 :param size: Specifies the maximum number of suggestions to return.

26e78fe6e8c4 "planemo upload commit c699937486c35866861690329de38ec1a5d9f783"

shellac

parents:

diff changeset

462

26e78fe6e8c4 "planemo upload commit c699937486c35866861690329de38ec1a5d9f783"

shellac

parents:

diff changeset

463 """

26e78fe6e8c4 "planemo upload commit c699937486c35866861690329de38ec1a5d9f783"

shellac

parents:

diff changeset

464 uri = '/2013-01-01/suggest'

26e78fe6e8c4 "planemo upload commit c699937486c35866861690329de38ec1a5d9f783"

shellac

parents:

diff changeset

465 params = {}

26e78fe6e8c4 "planemo upload commit c699937486c35866861690329de38ec1a5d9f783"

shellac

parents:

diff changeset

466 headers = {}

26e78fe6e8c4 "planemo upload commit c699937486c35866861690329de38ec1a5d9f783"

shellac

parents:

diff changeset

467 query_params = {}

26e78fe6e8c4 "planemo upload commit c699937486c35866861690329de38ec1a5d9f783"

shellac

parents:

diff changeset

468 if query is not None:

26e78fe6e8c4 "planemo upload commit c699937486c35866861690329de38ec1a5d9f783"

shellac

parents:

diff changeset

469 query_params['q'] = query

26e78fe6e8c4 "planemo upload commit c699937486c35866861690329de38ec1a5d9f783"

shellac

parents:

diff changeset

470 if suggester is not None:

26e78fe6e8c4 "planemo upload commit c699937486c35866861690329de38ec1a5d9f783"

shellac

parents:

diff changeset

471 query_params['suggester'] = suggester

26e78fe6e8c4 "planemo upload commit c699937486c35866861690329de38ec1a5d9f783"

shellac

parents:

diff changeset

472 if size is not None:

26e78fe6e8c4 "planemo upload commit c699937486c35866861690329de38ec1a5d9f783"

shellac

parents:

diff changeset

473 query_params['size'] = size

26e78fe6e8c4 "planemo upload commit c699937486c35866861690329de38ec1a5d9f783"

shellac

parents:

diff changeset

474 return self.make_request('GET', uri, expected_status=200,

26e78fe6e8c4 "planemo upload commit c699937486c35866861690329de38ec1a5d9f783"

shellac

parents:

diff changeset

475 data=json.dumps(params), headers=headers,

26e78fe6e8c4 "planemo upload commit c699937486c35866861690329de38ec1a5d9f783"

shellac

parents:

diff changeset

476 params=query_params)

26e78fe6e8c4 "planemo upload commit c699937486c35866861690329de38ec1a5d9f783"

shellac

parents:

diff changeset

477

26e78fe6e8c4 "planemo upload commit c699937486c35866861690329de38ec1a5d9f783"

shellac

parents:

diff changeset

478 def upload_documents(self, documents, content_type):

26e78fe6e8c4 "planemo upload commit c699937486c35866861690329de38ec1a5d9f783"

shellac

parents:

diff changeset

479 """

26e78fe6e8c4 "planemo upload commit c699937486c35866861690329de38ec1a5d9f783"

shellac

parents:

diff changeset

480 Posts a batch of documents to a search domain for indexing. A

26e78fe6e8c4 "planemo upload commit c699937486c35866861690329de38ec1a5d9f783"

shellac

parents:

diff changeset

481 document batch is a collection of add and delete operations

26e78fe6e8c4 "planemo upload commit c699937486c35866861690329de38ec1a5d9f783"

shellac

parents:

diff changeset

482 that represent the documents you want to add, update, or

26e78fe6e8c4 "planemo upload commit c699937486c35866861690329de38ec1a5d9f783"

shellac

parents:

diff changeset

483 delete from your domain. Batches can be described in either

26e78fe6e8c4 "planemo upload commit c699937486c35866861690329de38ec1a5d9f783"

shellac

parents:

diff changeset

484 JSON or XML. Each item that you want Amazon CloudSearch to

26e78fe6e8c4 "planemo upload commit c699937486c35866861690329de38ec1a5d9f783"

shellac

parents:

diff changeset

485 return as a search result (such as a product) is represented

26e78fe6e8c4 "planemo upload commit c699937486c35866861690329de38ec1a5d9f783"

shellac

parents:

diff changeset

486 as a document. Every document has a unique ID and one or more

26e78fe6e8c4 "planemo upload commit c699937486c35866861690329de38ec1a5d9f783"

shellac

parents:

diff changeset

487 fields that contain the data that you want to search and

26e78fe6e8c4 "planemo upload commit c699937486c35866861690329de38ec1a5d9f783"

shellac

parents:

diff changeset

488 return in results. Individual documents cannot contain more

26e78fe6e8c4 "planemo upload commit c699937486c35866861690329de38ec1a5d9f783"

shellac

parents:

diff changeset

489 than 1 MB of data. The entire batch cannot exceed 5 MB. To get

26e78fe6e8c4 "planemo upload commit c699937486c35866861690329de38ec1a5d9f783"

shellac

parents:

diff changeset

490 the best possible upload performance, group add and delete

26e78fe6e8c4 "planemo upload commit c699937486c35866861690329de38ec1a5d9f783"

shellac

parents:

diff changeset

491 operations in batches that are close the 5 MB limit.

26e78fe6e8c4 "planemo upload commit c699937486c35866861690329de38ec1a5d9f783"

shellac

parents:

diff changeset

492 Submitting a large volume of single-document batches can

26e78fe6e8c4 "planemo upload commit c699937486c35866861690329de38ec1a5d9f783"

shellac

parents:

diff changeset

493 overload a domain's document service.

26e78fe6e8c4 "planemo upload commit c699937486c35866861690329de38ec1a5d9f783"

shellac

parents:

diff changeset

494

26e78fe6e8c4 "planemo upload commit c699937486c35866861690329de38ec1a5d9f783"

shellac

parents:

diff changeset

495 The endpoint for submitting `UploadDocuments` requests is

26e78fe6e8c4 "planemo upload commit c699937486c35866861690329de38ec1a5d9f783"

shellac

parents:

diff changeset

496 domain-specific. To get the document endpoint for your domain,

26e78fe6e8c4 "planemo upload commit c699937486c35866861690329de38ec1a5d9f783"

shellac

parents:

diff changeset

497 use the Amazon CloudSearch configuration service

26e78fe6e8c4 "planemo upload commit c699937486c35866861690329de38ec1a5d9f783"

shellac

parents:

diff changeset

498 `DescribeDomains` action. A domain's endpoints are also

26e78fe6e8c4 "planemo upload commit c699937486c35866861690329de38ec1a5d9f783"

shellac

parents:

diff changeset

499 displayed on the domain dashboard in the Amazon CloudSearch

26e78fe6e8c4 "planemo upload commit c699937486c35866861690329de38ec1a5d9f783"

shellac

parents:

diff changeset

500 console.

26e78fe6e8c4 "planemo upload commit c699937486c35866861690329de38ec1a5d9f783"

shellac

parents:

diff changeset

501

26e78fe6e8c4 "planemo upload commit c699937486c35866861690329de38ec1a5d9f783"

shellac

parents:

diff changeset

502 For more information about formatting your data for Amazon

26e78fe6e8c4 "planemo upload commit c699937486c35866861690329de38ec1a5d9f783"

shellac

parents:

diff changeset

503 CloudSearch, see `Preparing Your Data`_ in the Amazon

26e78fe6e8c4 "planemo upload commit c699937486c35866861690329de38ec1a5d9f783"

shellac

parents:

diff changeset

504 CloudSearch Developer Guide . For more information about

26e78fe6e8c4 "planemo upload commit c699937486c35866861690329de38ec1a5d9f783"

shellac

parents:

diff changeset

505 uploading data for indexing, see `Uploading Data`_ in the

26e78fe6e8c4 "planemo upload commit c699937486c35866861690329de38ec1a5d9f783"

shellac

parents:

diff changeset

506 Amazon CloudSearch Developer Guide .

26e78fe6e8c4 "planemo upload commit c699937486c35866861690329de38ec1a5d9f783"

shellac

parents:

diff changeset

507

26e78fe6e8c4 "planemo upload commit c699937486c35866861690329de38ec1a5d9f783"

shellac

parents:

diff changeset

508 :type documents: blob

26e78fe6e8c4 "planemo upload commit c699937486c35866861690329de38ec1a5d9f783"

shellac

parents:

diff changeset

509 :param documents: A batch of documents formatted in JSON or HTML.

26e78fe6e8c4 "planemo upload commit c699937486c35866861690329de38ec1a5d9f783"

shellac

parents:

diff changeset

510

26e78fe6e8c4 "planemo upload commit c699937486c35866861690329de38ec1a5d9f783"

shellac

parents:

diff changeset

511 :type content_type: string

26e78fe6e8c4 "planemo upload commit c699937486c35866861690329de38ec1a5d9f783"

shellac

parents:

diff changeset

512 :param content_type:

26e78fe6e8c4 "planemo upload commit c699937486c35866861690329de38ec1a5d9f783"

shellac

parents:

diff changeset

513 The format of the batch you are uploading. Amazon CloudSearch supports

26e78fe6e8c4 "planemo upload commit c699937486c35866861690329de38ec1a5d9f783"

shellac

parents:

diff changeset

514 two document batch formats:

26e78fe6e8c4 "planemo upload commit c699937486c35866861690329de38ec1a5d9f783"

shellac

parents:

diff changeset

515

26e78fe6e8c4 "planemo upload commit c699937486c35866861690329de38ec1a5d9f783"

shellac

parents:

diff changeset

516

26e78fe6e8c4 "planemo upload commit c699937486c35866861690329de38ec1a5d9f783"

shellac

parents:

diff changeset

517 + application/json

26e78fe6e8c4 "planemo upload commit c699937486c35866861690329de38ec1a5d9f783"

shellac

parents:

diff changeset

518 + application/xml

26e78fe6e8c4 "planemo upload commit c699937486c35866861690329de38ec1a5d9f783"

shellac

parents:

diff changeset

519

26e78fe6e8c4 "planemo upload commit c699937486c35866861690329de38ec1a5d9f783"

shellac

parents:

diff changeset

520 """

26e78fe6e8c4 "planemo upload commit c699937486c35866861690329de38ec1a5d9f783"

shellac

parents:

diff changeset

521 uri = '/2013-01-01/documents/batch'

26e78fe6e8c4 "planemo upload commit c699937486c35866861690329de38ec1a5d9f783"

shellac

parents:

diff changeset

522 headers = {}

26e78fe6e8c4 "planemo upload commit c699937486c35866861690329de38ec1a5d9f783"

shellac

parents:

diff changeset

523 query_params = {}

26e78fe6e8c4 "planemo upload commit c699937486c35866861690329de38ec1a5d9f783"

shellac

parents:

diff changeset

524 if content_type is not None:

26e78fe6e8c4 "planemo upload commit c699937486c35866861690329de38ec1a5d9f783"

shellac

parents:

diff changeset

525 headers['Content-Type'] = content_type

26e78fe6e8c4 "planemo upload commit c699937486c35866861690329de38ec1a5d9f783"

shellac

parents:

diff changeset

526 return self.make_request('POST', uri, expected_status=200,

26e78fe6e8c4 "planemo upload commit c699937486c35866861690329de38ec1a5d9f783"

shellac

parents:

diff changeset

527 data=documents, headers=headers,

26e78fe6e8c4 "planemo upload commit c699937486c35866861690329de38ec1a5d9f783"

shellac

parents:

diff changeset

528 params=query_params)

26e78fe6e8c4 "planemo upload commit c699937486c35866861690329de38ec1a5d9f783"

shellac

parents:

diff changeset

529

26e78fe6e8c4 "planemo upload commit c699937486c35866861690329de38ec1a5d9f783"

shellac

parents:

diff changeset

530 def make_request(self, verb, resource, headers=None, data='',

26e78fe6e8c4 "planemo upload commit c699937486c35866861690329de38ec1a5d9f783"

shellac

parents:

diff changeset

531 expected_status=None, params=None):

26e78fe6e8c4 "planemo upload commit c699937486c35866861690329de38ec1a5d9f783"

shellac

parents:

diff changeset

532 if headers is None:

26e78fe6e8c4 "planemo upload commit c699937486c35866861690329de38ec1a5d9f783"

shellac

parents:

diff changeset

533 headers = {}

26e78fe6e8c4 "planemo upload commit c699937486c35866861690329de38ec1a5d9f783"

shellac

parents:

diff changeset

534 response = AWSAuthConnection.make_request(

26e78fe6e8c4 "planemo upload commit c699937486c35866861690329de38ec1a5d9f783"

shellac

parents:

diff changeset

535 self, verb, resource, headers=headers, data=data, params=params)

26e78fe6e8c4 "planemo upload commit c699937486c35866861690329de38ec1a5d9f783"

shellac

parents:

diff changeset

536 body = json.loads(response.read().decode('utf-8'))

26e78fe6e8c4 "planemo upload commit c699937486c35866861690329de38ec1a5d9f783"

shellac

parents:

diff changeset

537 if response.status == expected_status:

26e78fe6e8c4 "planemo upload commit c699937486c35866861690329de38ec1a5d9f783"

shellac

parents:

diff changeset

538 return body

26e78fe6e8c4 "planemo upload commit c699937486c35866861690329de38ec1a5d9f783"

shellac

parents:

diff changeset

539 else:

26e78fe6e8c4 "planemo upload commit c699937486c35866861690329de38ec1a5d9f783"

shellac

parents:

diff changeset

540 raise JSONResponseError(response.status, response.reason, body)

Mercurial > repos > shellac > guppy_basecaller

annotate env/lib/python3.7/site-packages/boto/cloudsearchdomain/layer1.py @ 0:26e78fe6e8c4 draft