Skip site navigation (1)Skip section navigation (2)

FreeBSD Manual Pages

  
 
  

home | help
Paws::CloudSearchDomaiUser Contributed Perl DocumentPaws::CloudSearchDomain(3)

NAME
       Paws::CloudSearchDomain - Perl Interface	to AWS Amazon CloudSearch
       Domain

SYNOPSIS
	 use Paws;

	 my $obj = Paws->service('CloudSearchDomain')->new;
	 my $res = $obj->Method(
	   Arg1	=> $val1,
	   Arg2	=> [ 'V1', 'V2'	],
	   # if	Arg3 is	an object, the HashRef will be used as arguments to the	constructor
	   # of	the arguments type
	   Arg3	=> { Att1 => 'Val1' },
	   # if	Arg4 is	an array of objects, the HashRefs will be passed as arguments to
	   # the constructor of	the arguments type
	   Arg4	=> [ { Att1 => 'Val1'  }, { Att1 => 'Val2' } ],
	 );

DESCRIPTION
       You use the AmazonCloudSearch2013 API to	upload documents to a search
       domain and search those documents.

       The endpoints for submitting "UploadDocuments", "Search", and "Suggest"
       requests	are domain-specific. To	get the	endpoints for your domain, use
       the Amazon CloudSearch configuration service "DescribeDomains" action.
       The domain endpoints are	also displayed on the domain dashboard in the
       Amazon CloudSearch console. You submit suggest requests to the search
       endpoint.

       For more	information, see the Amazon CloudSearch	Developer Guide.

METHODS
   Search(query	=> Str,	[cursor	=> Str,	expr =>	Str, facet => Str, filterQuery
       => Str, highlight => Str, partial => Bool, queryOptions => Str,
       queryParser => Str, return => Str, size => Int, sort => Str, start =>
       Int])
       Each argument is	described in detail in:
       Paws::CloudSearchDomain::Search

       Returns:	a Paws::CloudSearchDomain::SearchResponse instance

       Retrieves a list	of documents that match	the specified search criteria.
       How you specify the search criteria depends on which query parser you
       use. Amazon CloudSearch supports	four query parsers:

       o   "simple": search all	"text" and "text-array"	fields for the
	   specified string. Search for	phrases, individual terms, and
	   prefixes.

       o   "structured": search	specific fields, construct compound queries
	   using Boolean operators, and	use advanced features such as term
	   boosting and	proximity searching.

       o   "lucene": specify search criteria using the Apache Lucene query
	   parser syntax.

       o   "dismax": specify search criteria using the simplified subset of
	   the Apache Lucene query parser syntax defined by the	DisMax query
	   parser.

       For more	information, see Searching Your	Data in	the Amazon CloudSearch
       Developer Guide.

       The endpoint for	submitting "Search" requests is	domain-specific. You
       submit search requests to a domain's search endpoint. To	get the	search
       endpoint	for your domain, use the Amazon	CloudSearch configuration
       service "DescribeDomains" action. A domain's endpoints are also
       displayed on the	domain dashboard in the	Amazon CloudSearch console.

   Suggest(query => Str, suggester => Str, [size => Int])
       Each argument is	described in detail in:
       Paws::CloudSearchDomain::Suggest

       Returns:	a Paws::CloudSearchDomain::SuggestResponse instance

       Retrieves autocomplete suggestions for a	partial	query string. You can
       use suggestions enable you to display likely matches before users
       finish typing. In Amazon	CloudSearch, suggestions are based on the
       contents	of a particular	text field. When you request suggestions,
       Amazon CloudSearch finds	all of the documents whose values in the
       suggester field start with the specified	query string. The beginning of
       the field must match the	query string to	be considered a	match.

       For more	information about configuring suggesters and retrieving
       suggestions, see	Getting	Suggestions in the Amazon CloudSearch
       Developer Guide.

       The endpoint for	submitting "Suggest" requests is domain-specific. You
       submit suggest requests to a domain's search endpoint. To get the
       search endpoint for your	domain,	use the	Amazon CloudSearch
       configuration service "DescribeDomains" action. A domain's endpoints
       are also	displayed on the domain	dashboard in the Amazon	CloudSearch
       console.

   UploadDocuments(contentType => Str, documents => Str)
       Each argument is	described in detail in:
       Paws::CloudSearchDomain::UploadDocuments

       Returns:	a Paws::CloudSearchDomain::UploadDocumentsResponse instance

       Posts a batch of	documents to a search domain for indexing. A document
       batch is	a collection of	add and	delete operations that represent the
       documents you want to add, update, or delete from your domain. Batches
       can be described	in either JSON or XML. Each item that you want Amazon
       CloudSearch to return as	a search result	(such as a product) is
       represented as a	document. Every	document has a unique ID and one or
       more fields that	contain	the data that you want to search and return in
       results.	Individual documents cannot contain more than 1	MB of data.
       The entire batch	cannot exceed 5	MB. To get the best possible upload
       performance, group add and delete operations in batches that are	close
       the 5 MB	limit. Submitting a large volume of single-document batches
       can overload a domain's document	service.

       The endpoint for	submitting "UploadDocuments" requests is domain-
       specific. To get	the document endpoint for your domain, use the Amazon
       CloudSearch configuration service "DescribeDomains" action. A domain's
       endpoints are also displayed on the domain dashboard in the Amazon
       CloudSearch console.

       For more	information about formatting your data for Amazon CloudSearch,
       see Preparing Your Data in the Amazon CloudSearch Developer Guide.  For
       more information	about uploading	data for indexing, see Uploading Data
       in the Amazon CloudSearch Developer Guide.

SEE ALSO
       This service class forms	part of	Paws

BUGS and CONTRIBUTIONS
       The source code is located here:	https://github.com/pplu/aws-sdk-perl

       Please report bugs to: https://github.com/pplu/aws-sdk-perl/issues

perl v5.24.1			  2015-08-06	    Paws::CloudSearchDomain(3)

NAME | SYNOPSIS | DESCRIPTION | METHODS | SEE ALSO | BUGS and CONTRIBUTIONS

Want to link to this manual page? Use this URL:
<https://www.freebsd.org/cgi/man.cgi?query=Paws::CloudSearchDomain&sektion=3&manpath=FreeBSD+12.1-RELEASE+and+Ports>

home | help