« blib/lib/Paws/CloudSearch/UpdateServiceAccessPoliciesResponse.pm
↑ Summary
blib/lib/Paws/CloudSearchDomain/Bucket.pm »
| 1 | package Paws::CloudSearchDomain; | ||
| 2 | use Moose; | ||
| 3 | sub service { 'cloudsearchdomain' } | ||
| 4 | sub signing_name { 'cloudsearch' } | ||
| 5 | sub version { '2013-01-01' } | ||
| 6 | sub flattened_arrays { 0 } | ||
| 7 | has max_attempts => (is => 'ro', isa => 'Int', default => 5); | ||
| 8 | has retry => (is => 'ro', isa => 'HashRef', default => sub { | ||
| 9 | { base => 'rand', type => 'exponential', growth_factor => 2 } | ||
| 10 | }); | ||
| 11 | has retriables => (is => 'ro', isa => 'ArrayRef', default => sub { [ | ||
| 12 | ] }); | ||
| 13 | |||
| 14 | with 'Paws::API::Caller', 'Paws::API::EndpointResolver', 'Paws::Net::V4Signature', 'Paws::Net::RestJsonCaller'; | ||
| 15 | |||
| 16 | |||
| 17 | sub Search { | ||
| 18 | my $self = shift; | ||
| 19 | my $call_object = $self->new_with_coercions('Paws::CloudSearchDomain::Search', @_); | ||
| 20 | return $self->caller->do_call($self, $call_object); | ||
| 21 | } | ||
| 22 | sub Suggest { | ||
| 23 | my $self = shift; | ||
| 24 | my $call_object = $self->new_with_coercions('Paws::CloudSearchDomain::Suggest', @_); | ||
| 25 | return $self->caller->do_call($self, $call_object); | ||
| 26 | } | ||
| 27 | sub UploadDocuments { | ||
| 28 | my $self = shift; | ||
| 29 | my $call_object = $self->new_with_coercions('Paws::CloudSearchDomain::UploadDocuments', @_); | ||
| 30 | return $self->caller->do_call($self, $call_object); | ||
| 31 | } | ||
| 32 | |||
| 33 | |||
| 34 | |||
| 35 | sub operations { qw/Search Suggest UploadDocuments / } | ||
| 36 | |||
| 37 | 1; | ||
| 38 | |||
| 39 | ### main pod documentation begin ### | ||
| 40 | |||
| 41 | =head1 NAME | ||
| 42 | |||
| 43 | Paws::CloudSearchDomain - Perl Interface to AWS Amazon CloudSearch Domain | ||
| 44 | |||
| 45 | =head1 SYNOPSIS | ||
| 46 | |||
| 47 | use Paws; | ||
| 48 | |||
| 49 | my $obj = Paws->service('CloudSearchDomain'); | ||
| 50 | my $res = $obj->Method( | ||
| 51 | Arg1 => $val1, | ||
| 52 | Arg2 => [ 'V1', 'V2' ], | ||
| 53 | # if Arg3 is an object, the HashRef will be used as arguments to the constructor | ||
| 54 | # of the arguments type | ||
| 55 | Arg3 => { Att1 => 'Val1' }, | ||
| 56 | # if Arg4 is an array of objects, the HashRefs will be passed as arguments to | ||
| 57 | # the constructor of the arguments type | ||
| 58 | Arg4 => [ { Att1 => 'Val1' }, { Att1 => 'Val2' } ], | ||
| 59 | ); | ||
| 60 | |||
| 61 | =head1 DESCRIPTION | ||
| 62 | |||
| 63 | You use the AmazonCloudSearch2013 API to upload documents to a search | ||
| 64 | domain and search those documents. | ||
| 65 | |||
| 66 | The endpoints for submitting C<UploadDocuments>, C<Search>, and | ||
| 67 | C<Suggest> requests are domain-specific. To get the endpoints for your | ||
| 68 | domain, use the Amazon CloudSearch configuration service | ||
| 69 | C<DescribeDomains> action. The domain endpoints are also displayed on | ||
| 70 | the domain dashboard in the Amazon CloudSearch console. You submit | ||
| 71 | suggest requests to the search endpoint. | ||
| 72 | |||
| 73 | For more information, see the Amazon CloudSearch Developer Guide | ||
| 74 | (http://docs.aws.amazon.com/cloudsearch/latest/developerguide). | ||
| 75 | |||
| 76 | For the AWS API documentation, see L<https://docs.aws.amazon.com/cloudsearch/> | ||
| 77 | |||
| 78 | |||
| 79 | =head1 METHODS | ||
| 80 | |||
| 81 | =head2 Search | ||
| 82 | |||
| 83 | =over | ||
| 84 | |||
| 85 | =item Query => Str | ||
| 86 | |||
| 87 | =item [Cursor => Str] | ||
| 88 | |||
| 89 | =item [Expr => Str] | ||
| 90 | |||
| 91 | =item [Facet => Str] | ||
| 92 | |||
| 93 | =item [FilterQuery => Str] | ||
| 94 | |||
| 95 | =item [Highlight => Str] | ||
| 96 | |||
| 97 | =item [Partial => Bool] | ||
| 98 | |||
| 99 | =item [QueryOptions => Str] | ||
| 100 | |||
| 101 | =item [QueryParser => Str] | ||
| 102 | |||
| 103 | =item [Return => Str] | ||
| 104 | |||
| 105 | =item [Size => Int] | ||
| 106 | |||
| 107 | =item [Sort => Str] | ||
| 108 | |||
| 109 | =item [Start => Int] | ||
| 110 | |||
| 111 | =item [Stats => Str] | ||
| 112 | |||
| 113 | |||
| 114 | =back | ||
| 115 | |||
| 116 | Each argument is described in detail in: L<Paws::CloudSearchDomain::Search> | ||
| 117 | |||
| 118 | Returns: a L<Paws::CloudSearchDomain::SearchResponse> instance | ||
| 119 | |||
| 120 | Retrieves a list of documents that match the specified search criteria. | ||
| 121 | How you specify the search criteria depends on which query parser you | ||
| 122 | use. Amazon CloudSearch supports four query parsers: | ||
| 123 | |||
| 124 | =over | ||
| 125 | |||
| 126 | =item * C<simple>: search all C<text> and C<text-array> fields for the | ||
| 127 | specified string. Search for phrases, individual terms, and prefixes. | ||
| 128 | |||
| 129 | =item * C<structured>: search specific fields, construct compound | ||
| 130 | queries using Boolean operators, and use advanced features such as term | ||
| 131 | boosting and proximity searching. | ||
| 132 | |||
| 133 | =item * C<lucene>: specify search criteria using the Apache Lucene | ||
| 134 | query parser syntax. | ||
| 135 | |||
| 136 | =item * C<dismax>: specify search criteria using the simplified subset | ||
| 137 | of the Apache Lucene query parser syntax defined by the DisMax query | ||
| 138 | parser. | ||
| 139 | |||
| 140 | =back | ||
| 141 | |||
| 142 | For more information, see Searching Your Data | ||
| 143 | (http://docs.aws.amazon.com/cloudsearch/latest/developerguide/searching.html) | ||
| 144 | in the I<Amazon CloudSearch Developer Guide>. | ||
| 145 | |||
| 146 | The endpoint for submitting C<Search> requests is domain-specific. You | ||
| 147 | submit search requests to a domain's search endpoint. To get the search | ||
| 148 | endpoint for your domain, use the Amazon CloudSearch configuration | ||
| 149 | service C<DescribeDomains> action. A domain's endpoints are also | ||
| 150 | displayed on the domain dashboard in the Amazon CloudSearch console. | ||
| 151 | |||
| 152 | |||
| 153 | =head2 Suggest | ||
| 154 | |||
| 155 | =over | ||
| 156 | |||
| 157 | =item Query => Str | ||
| 158 | |||
| 159 | =item Suggester => Str | ||
| 160 | |||
| 161 | =item [Size => Int] | ||
| 162 | |||
| 163 | |||
| 164 | =back | ||
| 165 | |||
| 166 | Each argument is described in detail in: L<Paws::CloudSearchDomain::Suggest> | ||
| 167 | |||
| 168 | Returns: a L<Paws::CloudSearchDomain::SuggestResponse> instance | ||
| 169 | |||
| 170 | Retrieves autocomplete suggestions for a partial query string. You can | ||
| 171 | use suggestions enable you to display likely matches before users | ||
| 172 | finish typing. In Amazon CloudSearch, suggestions are based on the | ||
| 173 | contents of a particular text field. When you request suggestions, | ||
| 174 | Amazon CloudSearch finds all of the documents whose values in the | ||
| 175 | suggester field start with the specified query string. The beginning of | ||
| 176 | the field must match the query string to be considered a match. | ||
| 177 | |||
| 178 | For more information about configuring suggesters and retrieving | ||
| 179 | suggestions, see Getting Suggestions | ||
| 180 | (http://docs.aws.amazon.com/cloudsearch/latest/developerguide/getting-suggestions.html) | ||
| 181 | in the I<Amazon CloudSearch Developer Guide>. | ||
| 182 | |||
| 183 | The endpoint for submitting C<Suggest> requests is domain-specific. You | ||
| 184 | submit suggest requests to a domain's search endpoint. To get the | ||
| 185 | search endpoint for your domain, use the Amazon CloudSearch | ||
| 186 | configuration service C<DescribeDomains> action. A domain's endpoints | ||
| 187 | are also displayed on the domain dashboard in the Amazon CloudSearch | ||
| 188 | console. | ||
| 189 | |||
| 190 | |||
| 191 | =head2 UploadDocuments | ||
| 192 | |||
| 193 | =over | ||
| 194 | |||
| 195 | =item ContentType => Str | ||
| 196 | |||
| 197 | =item Documents => Str | ||
| 198 | |||
| 199 | |||
| 200 | =back | ||
| 201 | |||
| 202 | Each argument is described in detail in: L<Paws::CloudSearchDomain::UploadDocuments> | ||
| 203 | |||
| 204 | Returns: a L<Paws::CloudSearchDomain::UploadDocumentsResponse> instance | ||
| 205 | |||
| 206 | Posts a batch of documents to a search domain for indexing. A document | ||
| 207 | batch is a collection of add and delete operations that represent the | ||
| 208 | documents you want to add, update, or delete from your domain. Batches | ||
| 209 | can be described in either JSON or XML. Each item that you want Amazon | ||
| 210 | CloudSearch to return as a search result (such as a product) is | ||
| 211 | represented as a document. Every document has a unique ID and one or | ||
| 212 | more fields that contain the data that you want to search and return in | ||
| 213 | results. Individual documents cannot contain more than 1 MB of data. | ||
| 214 | The entire batch cannot exceed 5 MB. To get the best possible upload | ||
| 215 | performance, group add and delete operations in batches that are close | ||
| 216 | the 5 MB limit. Submitting a large volume of single-document batches | ||
| 217 | can overload a domain's document service. | ||
| 218 | |||
| 219 | The endpoint for submitting C<UploadDocuments> requests is | ||
| 220 | domain-specific. To get the document endpoint for your domain, use the | ||
| 221 | Amazon CloudSearch configuration service C<DescribeDomains> action. A | ||
| 222 | domain's endpoints are also displayed on the domain dashboard in the | ||
| 223 | Amazon CloudSearch console. | ||
| 224 | |||
| 225 | For more information about formatting your data for Amazon CloudSearch, | ||
| 226 | see Preparing Your Data | ||
| 227 | (http://docs.aws.amazon.com/cloudsearch/latest/developerguide/preparing-data.html) | ||
| 228 | in the I<Amazon CloudSearch Developer Guide>. For more information | ||
| 229 | about uploading data for indexing, see Uploading Data | ||
| 230 | (http://docs.aws.amazon.com/cloudsearch/latest/developerguide/uploading-data.html) | ||
| 231 | in the I<Amazon CloudSearch Developer Guide>. | ||
| 232 | |||
| 233 | |||
| 234 | |||
| 235 | |||
| 236 | =head1 PAGINATORS | ||
| 237 | |||
| 238 | Paginator methods are helpers that repetively call methods that return partial results | ||
| 239 | |||
| 240 | |||
| 241 | |||
| 242 | |||
| 243 | =head1 SEE ALSO | ||
| 244 | |||
| 245 | This service class forms part of L<Paws> | ||
| 246 | |||
| 247 | =head1 BUGS and CONTRIBUTIONS | ||
| 248 | |||
| 249 | The source code is located here: L<https://github.com/pplu/aws-sdk-perl> | ||
| 250 | |||
| 251 | Please report bugs to: L<https://github.com/pplu/aws-sdk-perl/issues> | ||
| 252 | |||
| 253 | =cut | ||
| 254 |