v1

latestOpenAPI 3.0.0Apache License 2.02026-07-263171,5614.1 MB

Data Kiosk v2023-11-15

getQuery

Returns query details for the query specified by the queryId parameter. See the createQuery operation for details about query retention.

Usage Plan:

Rate (requests per second)	Burst
2.0	15

The x-amzn-RateLimit-Limit response header returns the usage plan rate limits that were applied to the requested operation, when available. The table above indicates the default rate and burst values for this operation. Selling partners whose business demands require higher throughput may see higher rate and burst values than those shown here. For more information, refer to Usage Plans and Rate Limits in the Selling Partner API.

get/dataKiosk/2023-11-15/queries/{queryId}

Path parameters

queryIdstring required

The query identifier.

Response

Success.

queryIdstring required

The query identifier. This identifier is unique only in combination with a selling partner account ID.

querystring required

The submitted query.

createdTimestring date-time required

The date and time when the query was created, in ISO 8601 date time format.

processingStatus'CANCELLED' | 'DONE' | 'FATAL' | 'IN_PROGRESS' | 'IN_QUEUE' required

The processing status of the query.

processingStartTimestring date-time

The date and time when the query processing started, in ISO 8601 date time format.

processingEndTimestring date-time

The date and time when the query processing completed, in ISO 8601 date time format.

dataDocumentIdstring

The data document identifier. This identifier is only present when there is data available as a result of the query. This identifier is unique only in combination with a selling partner account ID. Pass this identifier into the getDocument operation to get the information required to retrieve the data document's contents.

errorDocumentIdstring

The error document identifier. This identifier is only present when an error occurs during query processing. This identifier is unique only in combination with a selling partner account ID. Pass this identifier into the getDocument operation to get the information required to retrieve the error document's contents.