| « PreviousNext » | |
   | Did this page help you? Yes | No | Tell us about it... |
Getting Information about an Amazon CloudSearch Domain
You can retrieve the following information about each of your search domains:
Domain Name—The name of the domain.
Document Endpoint—The endpoint through which you can submit document updates.
Search Endpoint—The endpoint through which you can submit search requests.
Searchable Documents—The number of documents that have been indexed.
Index Fields—The name and type of each configured index field.
Rank Expressions—The name and type of each rank expression.
When a domain is first created, the domain status will indicate that the domain is currently being activated and no other information will be available. Once your domain's document and search endpoints are available, the domain status will show the endpoint addresses that you can use to add data and submit search requests. If you haven't submitted any data for indexing, the number of searchable documents will be zero.
You can get domain information using the cs-describe-domain command, from the Amazon CloudSearch console, or using the DescribeDomains configuration action.
This section also shows how you can view your domain's access policies and text options through the console. For information about accessing them through the command line tools or API, see Configuring Access for an Amazon CloudSearch Domain and Configuring Text Options for an Amazon CloudSearch Domain.
Command Line Tools
You use the cs-describe-domain command to get information about your search domains. For information about installing and setting up the Amazon CloudSearch command line tools, see Amazon CloudSearch Command Line Tool Reference.
To get domain information
Run the
cs-describe-domaincommand to get information about all of your domains. To get information about a specific domain, use the--domain-nameoption to specify the domain that you are interested in. To include information about all of the domain's configured index fields and rank expressions, specify the--show-alloption. For example, the followwing request retrieves all of the available information about the domain named movies:cs-describe-domain --domain-name movies --show-all === Domain Summary === Domain Name: movies Document Service endpoint: doc-movies-h2pc7ftfnsdlqh6pqqawbftrhu.us-east-1. cloudsearch.amazonaws.com Search Service endpoint: search-movies-h2pc7ftfnsdlqh6pqqawbftrhu.us-east-1. cloudsearch.amazonaws.com SearchInstanceType: search.m1.small SearchPartitionCount: 1 SearchInstanceCount: 1 Searchable Documents: 5208 Current configuration changes require a call to IndexDocuments: No === Domain Configuration === Access Policies: ================ State: Active {"Version":"2011-10-11","Id":"34f11d91-88d9-4e15-8ebe-05dffef103c6", "Statement":[{"Sid":"1","Effect":"Allow","Action":"*", "Resource":"arn:aws:cs:us-east-1:598352442322:search/movies", "Condition":{"IpAddress":{"aws:SourceIp":["207.171.191.60/32"]}}}, {"Sid":"2","Effect":"Allow","Action":"*", "Resource":"arn:aws:cs:us-east-1:598352442322:doc/movies", "Condition":{"IpAddress":{"aws:SourceIp":["207.171.191.60/32"]}}}]} Fields: ======= actor Active text (Result) director Active text (Result) genre Active literal (Search Facet) title Active text (Result) year Active uint () ======================
AWS Management Console
You can use the Amazon CloudSearch console to view information about all of your domains. The console's Dashboard shows a summary of all of the domains that you have created.
To view detailed information about a particular domain
Go to the Amazon CloudSearch console at https://console.aws.amazon.com/cloudsearch/home.
Click the name of the domain in the Navigation panel. The Domain Dashboard shows the status summary for the selected domain.
To view the index fields configured for the domain, click the domain's Indexing Options link in the Navigation panel. The following screen shot shows the index fields and the indexing options for the imdb-movies domain. For more information about index fields, see Configuring Index Fields for an Amazon CloudSearch Domain.
To view the rank expressions configured for the domain, click the domain's Rank Expressions link in the Navigation panel. The following screen shot shows the rank expressions for the imdb-movies domain. For more information about rank expressions, see Customizing Result Ranking with Amazon CloudSearch.
To view the access policies configured for the domain, click the domain's Access Policies link in the Navigation panel. The following screen shot shows the access policies for the imdb-movies domain. For more information about access policies, see Configuring Access for an Amazon CloudSearch Domain.
To view the stopwords, synonyms, and stemmming options configured for the domain, click the domain's Text Options link in the Navigation panel. The following screen shot shows the text options for the imdb-movies domain. For information about text options, see Configuring Text Options for an Amazon CloudSearch Domain.
API
You use the DescribeDomains configuration action to get information about your domains. To get information about specific domains, specify the DomainNames parameter. For example, the following request shows how to get information about the movies and imdb-movies domains using the DescribeDomains configuration action:
https://cloudsearch.us-east-1.amazonaws.com ?Action=DescribeDomains &DomainNames.member.1=movies &DomainNames.member.2=imdb-movies &Version=2011-02-01 &X-Amz-Algorithm=AWS4-HMAC-SHA256 &X-Amz-Credential=AKIAIOSFODNN7EXAMPLE/20120330/us-east-1/cloudsearch/aws4_request &X-Amz-Date=2012-03-30T20:28:51.229Z &X-Amz-SignedHeaders=host &X-Amz-Signature=d8a4b3098bb37b73c48398db57315b272b92cbfcd 6b22ad1718c599b47466aea
If you omit the DomainNames parameter, DescribeDomains returns a summary of all your domains.
Note
Amazon CloudSearch configuration requests are authenticated using your AWS credentials. For more information about signing requests, see Request Authentication.
