Amazon Web Services, Inc.

Amazon CloudSearch Domain

You use the AmazonCloudSearch2013 API to upload documents to a search domain and search those documents. The endpoints for submitting UploadDocuments , Search…

Developer tools#openapi#cloud

Fork copies the collection into your workspace, without the publisher's secrets, so you can add your own key and send requests. Star saves it to your starred APIs (Account › Marketplace) and helps others find it.

Overview

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 .

Endpoints 3

  • GETSearch/2013-01-01/search?format=sdk&pretty=true&cursor=string&expr=string&facet=string&fq=string&highlight=string&partial=true&q=string&q.options=string&q.parser=string&return=string&size=0&sort=string&start=0&stats=stringRetrieves a list of documents that match the specified search criteria. How you specify the search criteria depends on which query parser you use. Amazon…
  • GETSuggest/2013-01-01/suggest?format=sdk&pretty=true&q=string&suggester=string&size=0Retrieves autocomplete suggestions for a partial query string. You can use suggestions enable you to display likely matches before users finish typing. In…
  • POSTUpload documents/2013-01-01/documents/batch?format=sdkPosts 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…

API details

Base URL
https://cloudsearchdomain.{region}.amazonaws.com
Authentication
AWS Signature Version 4 (requests signed with your AWS access key)
Operations
3 operations on 3 pathsGET 2POST 1
Description format
AWS Smithy model, API version 2013-01-01

How to test the Amazon CloudSearch Domain in Swastik Codes

  1. Open the APISelect “Fork & run in Swastik Codes” on this page. Sign in or create a free account if asked.
  2. Fork it into your workspaceChoose a workspace. You get your own copy of the Amazon CloudSearch Domain collection, without the publisher's secrets.
  3. Add your credentialsThis API uses AWS Signature Version 4 (requests signed with your AWS access key). Add yours in the collection's variables or an environment; the requests already reference it.
  4. Send a requestPick an endpoint, for example “Search” (GET /2013-01-01/search?format=sdk&pretty=true&cursor=string&expr=string&facet=string&fq=string&highlight=string&partial=true&q=string&q.options=string&q.parser=string&return=string&size=0&sort=string&start=0&stats=string), and press Send. Check the response, add tests and run the whole collection with the runner.

Frequently asked questions

What is the Amazon CloudSearch Domain?

You use the AmazonCloudSearch2013 API to upload documents to a search domain and search those documents. The endpoints for submitting UploadDocuments , Search… It is listed under Developer tools and has 3 endpoints.

Who publishes the Amazon CloudSearch Domain?

It is listed from Amazon Web Services, Inc.'s public API description (an OpenAPI document), not published by Amazon Web Services, Inc. on Swastik Codes. Anyone who controls amazonaws.com can claim the profile by adding a DNS TXT record.

What is the base URL of the Amazon CloudSearch Domain?

Requests go to https://cloudsearchdomain.{region}.amazonaws.com. Endpoint paths are added to this base URL.

How do I authenticate with the Amazon CloudSearch Domain?

With AWS Signature Version 4 (requests signed with your AWS access key).

How many endpoints does the Amazon CloudSearch Domain have?

3 operations on 3 paths (2 GET, 1 POST).

Is forking the Amazon CloudSearch Domain free?

Yes. Forking copies the collection into your workspace for free. It has been starred 0 times and forked 0 times.

Suggest an API

Tell us which public API is missing. We check it, then add it here with its endpoints when it has an OpenAPI (Swagger) description.