Amazon CloudSearch Developer Guide API Version 2011-02-01 Amazon CloudSearch Developer Guide Amazon CloudSearch: Developer Guide Copyright © 2014 Amazon Web Services, Inc. and/or its affiliates. All rights reserved. The following are trademarks of Amazon Web Services, Inc.: Amazon, Amazon Web Services Design, AWS, Amazon CloudFront, Cloudfront, Amazon DevPay, DynamoDB, ElastiCache, Amazon EC2, Amazon Elastic Compute Cloud, Amazon Glacier, Kindle, Kindle Fire, AWS Marketplace Design, Mechanical Turk, Amazon Redshift, Amazon Route 53, Amazon S3, Amazon VPC. In addition, Amazon.com graphics, logos, page headers, button icons, scripts, and service names are trademarks, or trade dress of Amazon in the U.S. and/or other countries. Amazon©s trademarks and trade dress may not be used in connection with any product or service that is not Amazon©s, in any manner that is likely to cause confusion among customers, or in any manner that disparages or discredits Amazon. All other trademarks not owned by Amazon are the property of their respective owners, who may or may not be affiliated with, connected to, or sponsored by Amazon. Amazon CloudSearch Developer Guide What Is Amazon CloudSearch? .............................................................................................................. 1 Search Data Format ............................................................................................................................... 3 Search Domain Configuration ................................................................................................................. 3 Search Requests .................................................................................................................................... 5 Getting Started ....................................................................................................................................... 8 Step 1: Before You Begin ........................................................................................................................ 9 Step 2: Create a Search Domain ............................................................................................................ 9 Step 3: Send Data for Indexing ............................................................................................................. 13 Step 4: Search Your Amazon CloudSearch Domain ............................................................................. 16 Step 5: Delete Your Amazon CloudSearch Movies Domain .................................................................. 21 Making API Requests ........................................................................................................................... 22 Regions and Endpoints ......................................................................................................................... 22 Making Configuration Requests ............................................................................................................ 24 Request Authentication ............................................................................................................... 25 Making Document Service Requests .................................................................................................. 26 Making Search Requests ..................................................................................................................... 27 Creating a Search Domain ................................................................................................................... 29 Configuring Access for a Search Domain ............................................................................................. 34 Monitoring Search Domains ................................................................................................................. 39 Getting Domain Information .................................................................................................................. 39 Viewing Search Metrics ........................................................................................................................ 44 Tracking your Amazon CloudSearch Usage and Charges .................................................................... 45 Deleting a Domain ................................................................................................................................ 47 Preparing Your Data .............................................................................................................................. 50 Mapping Document Data to Index Fields .............................................................................................. 50 Creating SDF Batches .......................................................................................................................... 51 Document Versions ..................................................................................................................... 53 Adding and Updating Documents ................................................................................................ 54 Deleting Documents .................................................................................................................... 54 Generating SDF (Experimental) .................................................................................................. 55 Configuring Index Fields ....................................................................................................................... 58 Adding Sources for a Field ................................................................................................................... 59 Command Line Tools ............................................................................................................................ 60 AWS Management Console ................................................................................................................. 61 API ........................................................................................................................................................ 66 Configuring Text Options ....................................................................................................................... 68 Configuring Stemming .......................................................................................................................... 68 Configuring Stopwords ......................................................................................................................... 71 Configuring Synonyms .......................................................................................................................... 74 Uploading Data ..................................................................................................................................... 77 Indexing Document Data ...................................................................................................................... 82 Searching Your Data ............................................................................................................................. 85 Submitting Search Requests ................................................................................................................ 86 Searching Text Fields ............................................................................................................................ 87 Using Boolean Operators in Text Searches ................................................................................. 89 Using Wildcards in Text Searches ............................................................................................... 90 Searching for Phrases in Text Fields ........................................................................................... 91 Searching Literal Fields ........................................................................................................................ 91 Searching Uint Fields ........................................................................................................................... 92 Constructing Boolean Search Queries ................................................................................................ 93 Controlling Search Results ................................................................................................................... 94 Getting Results as XML ............................................................................................................... 94 Paginating Results ...................................................................................................................... 95 Retrieving Data from Index Fields ............................................................................................... 95 Sorting Results ............................................................................................................................ 96 Getting and Using Facet Information .................................................................................................... 96 Getting Facet Information for Text and Literal Fields ................................................................... 97 Getting Facet Information for Uint Fields ..................................................................................... 97 API Version 2011-02-01 3 Amazon CloudSearch Developer Guide Getting Facet Information for Particular Values ........................................................................... 98 Sorting Facet Information