Amazon CloudSearch
Developer Guide (API Version 2013-01-01)
Next »
View the PDF for this guide.Go to the AWS Discussion Forum for this product.Go to the Kindle Store to download this guide in Kindle format.Did this page help you?  Yes | No |  Tell us about it...

What Is Amazon CloudSearch?

Amazon CloudSearch is a fully-managed service in the cloud that makes it easy to set up, manage, and scale a search solution for your website or application.

With Amazon CloudSearch you can search large collections of data such as web pages, document files, forum posts, or product information. You can quickly add search capabilities without having to become a search expert or worry about hardware provisioning, setup, and maintenance. As your volume of data and traffic fluctuates, Amazon CloudSearch scales to meet your needs.

Note

This document describes the Amazon CloudSearch 2013-01-01 API. If you have 2011-02-01 search domains and need to reference the old documentation, you can download a PDF of the 2011-02-01 Developer Guide.

You can use Amazon CloudSearch to index and search both structured data and plain text. Amazon CloudSearch features:

  • Full text search with language-specific text processing

  • Boolean search

  • Prefix searches

  • Range searches

  • Term boosting

  • Faceting

  • Highlighting

  • Autocomplete Suggestions

You can get search results in JSON or XML, sort and filter results based on field values, and sort results alphabetically, numerically, or according to custom expressions.

To build a search solution with Amazon CloudSearch, you take the following steps:

  • Create and configure a search domain. A search domain includes your searchable data and the search instances that handle your search requests. If you have multiple collections of data that you want to make searchable, you can create multiple search domains.

  • Upload the data you want to search to your domain. Amazon CloudSearch indexes your data and deploys the search index to one or more search instances.

  • Search your domain. You send a search request to your domain's search endpoint as an HTTP/HTTPS GET request.

Are You New to Amazon CloudSearch?

For a high-level overview of Amazon CloudSearch, service highlights, and pricing information, see the Amazon CloudSearch detail page. If you are ready to start using Amazon CloudSearch, you should begin with Getting Started with Amazon CloudSearch.

The easiest way to interact with Amazon CloudSearch is through the AWS Management Console. Amazon CloudSearch also provides a set of command line tools that wrap the configuration APIs and automate the process of preparing and uploading your data. For information about installing and using the Amazon CloudSearch command line interface (CLI), see Command Line Tool Reference. The AWS SDKs also provide wrappers for the configuration APIs, eliminating the need to sign your own API requests. For information about the AWS SDKs, see Tools for Amazon Web Services. For detailed information about the Amazon CloudSearch APIs, see the Configuration API Reference for Amazon CloudSearch , Document Service API Reference, and the Search API Reference.

For more information about configuring and manage your search domains, getting your data into Amazon CloudSearch, submitting search requests, and processing the responses, see:

Accessing Amazon CloudSearch

You can access Amazon CloudSearch through the Amazon CloudSearch console, the Amazon CloudSearch command line tools, or the AWS SDKs.

  • The Amazon CloudSearch console enables you to easily create, configure, and monitor your search domains, upload documents, and run test searches. Using the console is the easiest way to get started with Amazon CloudSearch and provides a central command center for ongoing management of your search domains.

  • The Amazon CloudSearch command line tools wrap the Amazon CloudSearch configuration and document service APIs to provide a simple way to create and configure search domains and prepare and upload the data you want to search. The command line tools automatically sign requests submitted to the configuration service using your AWS credentials.

  • The AWS SDKs support all of the Amazon CloudSearch configuration service actions, making it easy to manage your search domain's using your preferred technology.

You can upload documents and search your data by submitting HTTP requests directly to a domain's document and search service endpoints. You can send HTTP requests through cURL or any HTTP library. You can also send search requests directly from a Web browser.

You can also create and manage your domains by submitting requests directly to the Amazon CloudSearch Configuration API. When using the Configuration API directly, you must write the necessary code to sign and authenticate your requests. For more information, see Configuration API Reference for Amazon CloudSearch .

Regions and Endpoints for Amazon CloudSearch

Amazon CloudSearch provides regional endpoints for accessing the configuration service and domain-specific endpoints for accessing the search and document services.

You use the configuration service to create and manage your search domains. The region-specific configuration service endpoints are of the form: cloudsearch.region.amazonaws.com. For example, cloudsearch.us-east-1.amazonaws.com. For a current list of supported regions, see Regions and Endpoints in the AWS General Reference.

To access the Amazon CloudSearch search and document services, you use separate domain-specific endpoints:

  • http://doc-domainname-domainid.us-east-1.cloudsearch.amazonaws.com—a domain's document service endpoint is used to upload documents.

  • http://search-domainname-domainid.us-east-1.cloudsearch.amazonaws.com—a domain's search endpoint is used to submit search requests.