| « PreviousNext » | |
   | Did this page help you? Yes | No | Tell us about it... |
Making Configuration Requests in Amazon CloudSearch
Amazon CloudSearch configuration requests are submitted using the AWS Query protocol. AWS Query requests are HTTP or HTTPS requests submitted via HTTP GET or POST with a query parameter named Action.
The endpoint for Amazon CloudSearch configuration requests is region-specific: cloudsearch.. For example, region.amazonaws.comcloudsearch.us-east-1.amazonaws.com. For a current list of supported regions and endpoints, see Regions and Endpoints.
Important
The easiest way to submit configuration requests is to use the Amazon CloudSearch command line tools or the AWS SDK for Java, .NET, PHP, Ruby, and Python (Boto). The command line tools and SDKs handle the signing process for you and ensure that Amazon CloudSearch configuration requests are properly formed. For more information about using the command line tools, see Amazon CloudSearch Command Line Tool Reference. For more information about the AWS SDKs, see AWS Software Development Kits.
Structure of a Configuration Request
This guide shows Amazon CloudSearch configuration requests as URLs, which can be used directly in a browser. The URL contains three parts:
Endpoint—the Web service entry point to act on,
cloudsearch.us-east-1.amazonaws.com.Action—the Amazon CloudSearch configuration action you want to perform. For a complete list of actions, see Actions.
Parameters—any request parameters required for the specified action. Each query request must also include some common parameters to handle authentication. For more information, see Request Authentication.
You must specify the Version parameter in every Amazon CloudSearch configuration request. The current Amazon CloudSearch API version is 2011-02-01.
For example, the following GET request creates a new search domain called movies:
https://cloudsearch.us-east-1.amazonaws.com ?Action=CreateDomain &DomainName=movies &Version=2011-02-01 &X-Amz-Algorithm=AWS4-HMAC-SHA256 &X-Amz-Credential=AKIAIOSFODNN7EXAMPLE/20120712/us-east-1/cloudsearch/aws4 _request &X-Amz-Date=2012-07-12T21:41:29.094Z &X-Amz-SignedHeaders=host &X-Amz-Signature=c7600a00fea082dac002b247f9d6812f25195fbaf7f0a6fc4ce08a39666c6a10 3c8dcb
Note
Although the GET requests are shown as URLs, the parameter values are shown unencoded to make them easier to read. Keep in mind that you must URL encode parameter values when submitting requests.
