Amazon Web Services, Inc.

Amazon CloudSearch

Amazon CloudSearch Configuration Service You use the Amazon CloudSearch configuration service to create, configure, and manage search domains. Configuration…

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

Amazon CloudSearch Configuration Service
You use the Amazon CloudSearch configuration service to create, configure, and manage search domains.
Configuration service 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 configuration service requests is region-specific: cloudsearch. region .amazonaws.com.
For example, cloudsearch.us-east-1.amazonaws.com. For a current list of supported regions and endpoints,
see Regions and Endpoints .

Endpoints 26

  • POSTBuild suggesters/#Action=BuildSuggesters?Action=BuildSuggesters&Version=2013-01-01Indexes the search suggestions. For more information, see Configuring Suggesters in the Amazon CloudSearch Developer Guide .
  • POSTCreate domain/#Action=CreateDomain?Action=CreateDomain&Version=2013-01-01Creates a new search domain. For more information, see Creating a Search Domain in the Amazon CloudSearch Developer Guide .
  • POSTDefine analysis scheme/#Action=DefineAnalysisScheme?Action=DefineAnalysisScheme&Version=2013-01-01Configures an analysis scheme that can be applied to a text or text-array field to define language-specific text processing options. For more information, see…
  • POSTDefine expression/#Action=DefineExpression?Action=DefineExpression&Version=2013-01-01Configures an Expression for the search domain. Used to create new expressions and modify existing ones. If the expression exists, the new configuration…
  • POSTDefine index field/#Action=DefineIndexField?Action=DefineIndexField&Version=2013-01-01Configures an IndexField for the search domain. Used to create new fields and modify existing ones. You must specify the name of the domain you are…
  • POSTDefine suggester/#Action=DefineSuggester?Action=DefineSuggester&Version=2013-01-01Configures a suggester for a domain. A suggester enables you to display possible matches before users finish typing their queries. When you configure a…
  • POSTDelete analysis scheme/#Action=DeleteAnalysisScheme?Action=DeleteAnalysisScheme&Version=2013-01-01Deletes an analysis scheme. For more information, see Configuring Analysis Schemes in the Amazon CloudSearch Developer Guide .
  • POSTDelete domain/#Action=DeleteDomain?Action=DeleteDomain&Version=2013-01-01Permanently deletes a search domain and all of its data. Once a domain has been deleted, it cannot be recovered. For more information, see Deleting a Search…
  • POSTDelete expression/#Action=DeleteExpression?Action=DeleteExpression&Version=2013-01-01Removes an Expression from the search domain. For more information, see Configuring Expressions in the Amazon CloudSearch Developer Guide .
  • POSTDelete index field/#Action=DeleteIndexField?Action=DeleteIndexField&Version=2013-01-01Removes an IndexField from the search domain. For more information, see Configuring Index Fields in the Amazon CloudSearch Developer Guide .
  • POSTDelete suggester/#Action=DeleteSuggester?Action=DeleteSuggester&Version=2013-01-01Deletes a suggester. For more information, see Getting Search Suggestions in the Amazon CloudSearch Developer Guide .
  • POSTDescribe analysis schemes/#Action=DescribeAnalysisSchemes?Action=DescribeAnalysisSchemes&Version=2013-01-01Gets the analysis schemes configured for a domain. An analysis scheme defines language-specific text processing options for a text field. Can be limited to…
  • POSTDescribe availability options/#Action=DescribeAvailabilityOptions?Action=DescribeAvailabilityOptions&Version=2013-01-01Gets the availability options configured for a domain. By default, shows the configuration with any pending changes. Set the Deployed option to true to show…
  • POSTDescribe domain endpoint options/#Action=DescribeDomainEndpointOptions?Action=DescribeDomainEndpointOptions&Version=2013-01-01Returns the domain's endpoint options, specifically whether all requests to the domain must arrive over HTTPS. For more information, see Configuring Domain…
  • POSTDescribe domains/#Action=DescribeDomains?Action=DescribeDomains&Version=2013-01-01Gets information about the search domains owned by this account. Can be limited to specific domains. Shows all domains by default. To get the number of…
  • POSTDescribe expressions/#Action=DescribeExpressions?Action=DescribeExpressions&Version=2013-01-01Gets the expressions configured for the search domain. Can be limited to specific expressions by name. By default, shows all expressions and includes any…
  • POSTDescribe index fields/#Action=DescribeIndexFields?Action=DescribeIndexFields&Version=2013-01-01Gets information about the index fields configured for the search domain. Can be limited to specific fields by name. By default, shows all fields and includes…
  • POSTDescribe scaling parameters/#Action=DescribeScalingParameters?Action=DescribeScalingParameters&Version=2013-01-01Gets the scaling parameters configured for a domain. A domain's scaling parameters specify the desired search instance type and replication count. For more…
  • POSTDescribe service access policies/#Action=DescribeServiceAccessPolicies?Action=DescribeServiceAccessPolicies&Version=2013-01-01Gets information about the access policies that control access to the domain's document and search endpoints. By default, shows the configuration with any…
  • POSTDescribe suggesters/#Action=DescribeSuggesters?Action=DescribeSuggesters&Version=2013-01-01Gets the suggesters configured for a domain. A suggester enables you to display possible matches before users finish typing their queries. Can be limited to…
  • POSTIndex documents/#Action=IndexDocuments?Action=IndexDocuments&Version=2013-01-01Tells the search domain to start indexing its documents using the latest indexing options. This operation must be invoked to activate options whose…
  • POSTList domain names/#Action=ListDomainNames?Action=ListDomainNames&Version=2013-01-01Lists all search domains owned by an account.
  • POSTUpdate availability options/#Action=UpdateAvailabilityOptions?Action=UpdateAvailabilityOptions&Version=2013-01-01Configures the availability options for a domain. Enabling the Multi-AZ option expands an Amazon CloudSearch domain to an additional Availability Zone in the…
  • POSTUpdate domain endpoint options/#Action=UpdateDomainEndpointOptions?Action=UpdateDomainEndpointOptions&Version=2013-01-01Updates the domain's endpoint options, specifically whether all requests to the domain must arrive over HTTPS. For more information, see Configuring Domain…
  • POSTUpdate scaling parameters/#Action=UpdateScalingParameters?Action=UpdateScalingParameters&Version=2013-01-01Configures scaling parameters for a domain. A domain's scaling parameters specify the desired search instance type and replication count. Amazon CloudSearch…
  • POSTUpdate service access policies/#Action=UpdateServiceAccessPolicies?Action=UpdateServiceAccessPolicies&Version=2013-01-01Configures the access rules that control access to the domain's document and search endpoints. For more information, see Configuring Access for an Amazon…

API details

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

How to test the Amazon CloudSearch 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 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 “Build suggesters” (POST /#Action=BuildSuggesters?Action=BuildSuggesters&Version=2013-01-01), and press Send. Check the response, add tests and run the whole collection with the runner.

Frequently asked questions

What is the Amazon CloudSearch?

Amazon CloudSearch Configuration Service You use the Amazon CloudSearch configuration service to create, configure, and manage search domains. Configuration… It is listed under Developer tools and has 26 endpoints.

Who publishes the Amazon CloudSearch?

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?

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

How do I authenticate with the Amazon CloudSearch?

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

How many endpoints does the Amazon CloudSearch have?

26 operations on 26 paths (26 POST).

Is forking the Amazon CloudSearch 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.