GetStatus

Description

Query the search engine to find out the status of a StartSearch or StartGrep request. If the status is 'Completed' then If the status is "Completed," then the URL where you can download your results from is returned..

Request Parameters

Name	Description	Required
ActionRequestId	Pass in the ActionRequestId returned from a StartSearch or StartGrep action.	Yes

Response Elements

Name	Description
ActionRequestId	The action request ID of the action
Code	The status of the request: Queued - Your request has been queued. Executing - Your request is executing. Error - An error occurred. Completed - Your request has completed. Unknown - The ActionRequestId you passed in is unknown. Expired - The ActionRequestId has expired.
Message	A status message
DownloadUrl	If the code is "Completed," this element contains the URL where you can download the gzipped text file containing your results from. The URL expires after 15 minutes. Note that the URL contains ampersands encoded as `&`. These must be replaced with `&` in the actual download url;
StartDate	The date and time the action was submitted. Results are available for download for 48 hours from this time.

Example

The following example shows a Query-style request and response.

Request

     http://msearch.amazonaws.com?     
     Action=GetStatus
     &Version=2007-03-15     
     &AWSAccessKeyId=[Your AWS Access Key ID]
     &Timestamp=[Current timestamp]
     &Signature=[Calculated request signature]
     &ActionRequestId=[Request Id from StartSearch action]

Response

When a query is executing the response looks like this:

     <GetStatusResponse xmlns:aws="http://msearch.amazonaws.com/doc/2007-03-15/">  
        <GetStatusResult>
           <Status>
           	   <ActionRequestId>72e31953-cf4c-4ebd-82e5-832a7754c0d8</ActionRequestId>
	           <ActionName>StartSearch</ActionName>
    		   <Code>Executing</Code>
     		   <Message>Your Query request is currently executing.</Message>
	           <StartDate>2007-01-26T01%3A15%3A38.000Z</StartDate>     		   
           </Status>
        </GetStatusResult>
        <ResponseMetadata>
			<RequestId>2167c9cb-cf4c-4ebd-82e5-832a7754c0d8</RequestId>
        </ResponseMetadata>          
     </GetStatusResponse>

When a query has completed the response includes a download URL where the results can be downloaded.

     <GetStatusResponse xmlns:aws="http://msearch.amazonaws.com/doc/2007-03-15/">   
        <GetStatusResult>
           <Status>
           	   <ActionRequestId>72e31953-cf4c-4ebd-82e5-832a7754c0d8</ActionRequestId>
    		   <Code>Completed</Code>
     		   <Message>Results are available for download from DownloadUrl</Message>
	           <ActionName>StartSearch</ActionName>
	           <StartDate>2007-01-26T01%3A15%3A38.000Z</StartDate>
	           <DownloadUrl>https://s3.amazonaws.com/com.alexa.msr.prod/msr_37d75491-617e-45ab-af73-10ab03e15579.dat.gz?&Expires=1178661037</aws:DownloadUrl>
           </Status>
        </GetStatusResult>
        <ResponseMetaData>
			<RequestId>2167c9cb-cf4c-4ebd-82e5-832a7754c0d8</RequestId>
        </ResponseMetaData>          
     </GetStatusResponse>