Amazon CloudSearch Domain
amazonaws · Cloud
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 request
Authentication
Sample Requests
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: simple : search all text and text-array fields for
Hover any highlighted part to learn what it does
curl -X GET "https://api.apis.guru/v2/specs/amazonaws.com/cloudsearchdomain/2013-01-01/2013-01-01/search#format=sdk&pretty=true&q?q=test&fq=example&expr=example&size=10&sort=desc&facet=example&start=1&stats=example&cursor=example&format=sdk&pretty=true&return=example&partial=true&q.parser=simple&highlight=example&q.options=example"
import requests
params = {
"q": "test",
"fq": "example",
"expr": "example",
"size": "10",
"sort": "desc",
"facet": "example",
"start": "1",
"stats": "example",
"cursor": "example",
"format": "sdk",
"pretty": "true",
"return": "example",
"partial": "true",
"q.parser": "simple",
"highlight": "example",
"q.options": "example"
}
response = requests.get(
"https://api.apis.guru/v2/specs/amazonaws.com/cloudsearchdomain/2013-01-01/2013-01-01/search#format=sdk&pretty=true&q",
params=params,
)
print(response.json())const url = new URL('https://api.apis.guru/v2/specs/amazonaws.com/cloudsearchdomain/2013-01-01/2013-01-01/search#format=sdk&pretty=true&q');
url.searchParams.set('q', 'test');
url.searchParams.set('fq', 'example');
url.searchParams.set('expr', 'example');
url.searchParams.set('size', '10');
url.searchParams.set('sort', 'desc');
url.searchParams.set('facet', 'example');
url.searchParams.set('start', '1');
url.searchParams.set('stats', 'example');
url.searchParams.set('cursor', 'example');
url.searchParams.set('format', 'sdk');
url.searchParams.set('pretty', 'true');
url.searchParams.set('return', 'example');
url.searchParams.set('partial', 'true');
url.searchParams.set('q.parser', 'simple');
url.searchParams.set('highlight', 'example');
url.searchParams.set('q.options', 'example');
const response = await fetch(url);
const data = await response.json();
console.log(data);package main
import (
"fmt"
"io"
"net/http"
"net/url"
)
func main() {
baseURL, _ := url.Parse("https://api.apis.guru/v2/specs/amazonaws.com/cloudsearchdomain/2013-01-01/2013-01-01/search#format=sdk&pretty=true&q")
q := baseURL.Query()
q.Set("q", "test")
q.Set("fq", "example")
q.Set("expr", "example")
q.Set("size", "10")
q.Set("sort", "desc")
q.Set("facet", "example")
q.Set("start", "1")
q.Set("stats", "example")
q.Set("cursor", "example")
q.Set("format", "sdk")
q.Set("pretty", "true")
q.Set("return", "example")
q.Set("partial", "true")
q.Set("q.parser", "simple")
q.Set("highlight", "example")
q.Set("q.options", "example")
baseURL.RawQuery = q.Encode()
targetURL := baseURL.String()
req, _ := http.NewRequest("GET", targetURL, nil)
client := &http.Client{}
resp, _ := client.Do(req)
defer resp.Body.Close()
body, _ := io.ReadAll(resp.Body)
fmt.Println(string(body))
}require "net/http"
require "json"
uri = URI("https://api.apis.guru/v2/specs/amazonaws.com/cloudsearchdomain/2013-01-01/2013-01-01/search#format=sdk&pretty=true&q")
uri.query = URI.encode_www_form({
"q" => "test",
"fq" => "example",
"expr" => "example",
"size" => "10",
"sort" => "desc",
"facet" => "example",
"start" => "1",
"stats" => "example",
"cursor" => "example",
"format" => "sdk",
"pretty" => "true",
"return" => "example",
"partial" => "true",
"q.parser" => "simple",
"highlight" => "example",
"q.options" => "example"
})
http = Net::HTTP.new(uri.host, uri.port)
http.use_ssl = uri.scheme == "https"
req = Net::HTTP::Get.new(uri)
res = http.request(req)
puts JSON.parse(res.body)<?php
$url = "https://api.apis.guru/v2/specs/amazonaws.com/cloudsearchdomain/2013-01-01/2013-01-01/search#format=sdk&pretty=true&q?" . http_build_query([
"q" => "test",
"fq" => "example",
"expr" => "example",
"size" => "10",
"sort" => "desc",
"facet" => "example",
"start" => "1",
"stats" => "example",
"cursor" => "example",
"format" => "sdk",
"pretty" => "true",
"return" => "example",
"partial" => "true",
"q.parser" => "simple",
"highlight" => "example",
"q.options" => "example"
]);
$opts = ["http" => [
"method" => "GET",
]];
$ctx = stream_context_create($opts);
$res = file_get_contents($url, false, $ctx);
print_r(json_decode($res, true));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 a
Hover any highlighted part to learn what it does
curl -X GET "https://api.apis.guru/v2/specs/amazonaws.com/cloudsearchdomain/2013-01-01/2013-01-01/suggest#format=sdk&pretty=true&q&suggester?q=test&size=10&format=sdk&pretty=true&suggester=example"
import requests
params = {
"q": "test",
"size": "10",
"format": "sdk",
"pretty": "true",
"suggester": "example"
}
response = requests.get(
"https://api.apis.guru/v2/specs/amazonaws.com/cloudsearchdomain/2013-01-01/2013-01-01/suggest#format=sdk&pretty=true&q&suggester",
params=params,
)
print(response.json())const url = new URL('https://api.apis.guru/v2/specs/amazonaws.com/cloudsearchdomain/2013-01-01/2013-01-01/suggest#format=sdk&pretty=true&q&suggester');
url.searchParams.set('q', 'test');
url.searchParams.set('size', '10');
url.searchParams.set('format', 'sdk');
url.searchParams.set('pretty', 'true');
url.searchParams.set('suggester', 'example');
const response = await fetch(url);
const data = await response.json();
console.log(data);package main
import (
"fmt"
"io"
"net/http"
"net/url"
)
func main() {
baseURL, _ := url.Parse("https://api.apis.guru/v2/specs/amazonaws.com/cloudsearchdomain/2013-01-01/2013-01-01/suggest#format=sdk&pretty=true&q&suggester")
q := baseURL.Query()
q.Set("q", "test")
q.Set("size", "10")
q.Set("format", "sdk")
q.Set("pretty", "true")
q.Set("suggester", "example")
baseURL.RawQuery = q.Encode()
targetURL := baseURL.String()
req, _ := http.NewRequest("GET", targetURL, nil)
client := &http.Client{}
resp, _ := client.Do(req)
defer resp.Body.Close()
body, _ := io.ReadAll(resp.Body)
fmt.Println(string(body))
}require "net/http"
require "json"
uri = URI("https://api.apis.guru/v2/specs/amazonaws.com/cloudsearchdomain/2013-01-01/2013-01-01/suggest#format=sdk&pretty=true&q&suggester")
uri.query = URI.encode_www_form({
"q" => "test",
"size" => "10",
"format" => "sdk",
"pretty" => "true",
"suggester" => "example"
})
http = Net::HTTP.new(uri.host, uri.port)
http.use_ssl = uri.scheme == "https"
req = Net::HTTP::Get.new(uri)
res = http.request(req)
puts JSON.parse(res.body)<?php
$url = "https://api.apis.guru/v2/specs/amazonaws.com/cloudsearchdomain/2013-01-01/2013-01-01/suggest#format=sdk&pretty=true&q&suggester?" . http_build_query([
"q" => "test",
"size" => "10",
"format" => "sdk",
"pretty" => "true",
"suggester" => "example"
]);
$opts = ["http" => [
"method" => "GET",
]];
$ctx = stream_context_create($opts);
$res = file_get_contents($url, false, $ctx);
print_r(json_decode($res, true));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
Hover any highlighted part to learn what it does
| Content-Type | application/json |
curl -X POST "https://api.apis.guru/v2/specs/amazonaws.com/cloudsearchdomain/2013-01-01/2013-01-01/documents/batch#format=sdk&Content-Type?format=sdk" \ -H "Content-Type: application/json"
import requests
params = {
"format": "sdk"
}
headers = {
"Content-Type": "application/json"
}
response = requests.post(
"https://api.apis.guru/v2/specs/amazonaws.com/cloudsearchdomain/2013-01-01/2013-01-01/documents/batch#format=sdk&Content-Type",
params=params,
headers=headers,
)
print(response.json())const url = new URL('https://api.apis.guru/v2/specs/amazonaws.com/cloudsearchdomain/2013-01-01/2013-01-01/documents/batch#format=sdk&Content-Type');
url.searchParams.set('format', 'sdk');
const response = await fetch(url, {
method: 'POST',
headers: {
'Content-Type': 'application/json'
},
});
const data = await response.json();
console.log(data);package main
import (
"fmt"
"io"
"net/http"
"net/url"
)
func main() {
baseURL, _ := url.Parse("https://api.apis.guru/v2/specs/amazonaws.com/cloudsearchdomain/2013-01-01/2013-01-01/documents/batch#format=sdk&Content-Type")
q := baseURL.Query()
q.Set("format", "sdk")
baseURL.RawQuery = q.Encode()
targetURL := baseURL.String()
req, _ := http.NewRequest("POST", targetURL, nil)
req.Header.Set("Content-Type", "application/json")
client := &http.Client{}
resp, _ := client.Do(req)
defer resp.Body.Close()
body, _ := io.ReadAll(resp.Body)
fmt.Println(string(body))
}require "net/http"
require "json"
uri = URI("https://api.apis.guru/v2/specs/amazonaws.com/cloudsearchdomain/2013-01-01/2013-01-01/documents/batch#format=sdk&Content-Type")
uri.query = URI.encode_www_form({
"format" => "sdk"
})
http = Net::HTTP.new(uri.host, uri.port)
http.use_ssl = uri.scheme == "https"
req = Net::HTTP::Post.new(uri)
req["Content-Type"] = "application/json"
res = http.request(req)
puts JSON.parse(res.body)<?php
$url = "https://api.apis.guru/v2/specs/amazonaws.com/cloudsearchdomain/2013-01-01/2013-01-01/documents/batch#format=sdk&Content-Type?" . http_build_query([
"format" => "sdk"
]);
$opts = ["http" => [
"method" => "POST",
"header" => implode("\r\n", [
"Content-Type: application/json"
]),
]];
$ctx = stream_context_create($opts);
$res = file_get_contents($url, false, $ctx);
print_r(json_decode($res, true));Postman Setup Guide
- See official documentation for authentication and setup.
What can you build with Amazon CloudSearch Domain?
Amazon CloudSearch Domain is a Cloud API. Developers commonly use cloud APIs for:
- provisioning and managing cloud infrastructure
- automating deployments and container orchestration
- monitoring uptime and performance metrics
- managing storage buckets and databases
- setting up auto-scaling and load balancing
No authentication required. This API is open — no signup or key needed. Ideal for quick prototypes and public-facing features. Amazon CloudSearch Domain is free to use, making it a low-risk choice to experiment with.
New to APIs? Read our beginner's guide · Learn about API keys · What is REST?