Data Kiosk API v2023-11-15 Model
Swagger model for Data Kiosk API v2023-11-15.
{
"swagger": "2.0",
"info": {
"description": "The Selling Partner API for Data Kiosk lets you submit GraphQL queries from a variety of schemas to help selling partners manage their businesses.",
"version": "2023-11-15",
"title": "Selling Partner API for Data Kiosk",
"contact": {
"name": "Selling Partner API Developer Support",
"url": "https://sellercentral.amazon.com/gp/mws/contactus.html"
},
"license": {
"name": "Apache License 2.0",
"url": "http://www.apache.org/licenses/LICENSE-2.0"
}
},
"host": "sellingpartnerapi-na.amazon.com",
"schemes": [
"https"
],
"consumes": [
"application/json"
],
"produces": [
"application/json"
],
"paths": {
"/dataKiosk/2023-11-15/queries": {
"get": {
"tags": [
"queries"
],
"operationId": "getQueries",
"description": "Returns details for the Data Kiosk queries that match the specified filters. See the `createQuery` operation for details about query retention.\n\n**Usage Plan:**\n\n| Rate (requests per second) | Burst |\n| ---- | ---- |\n| 0.0222 | 10 |\n\nThe `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](https://developer-docs.amazon.com/sp-api/docs/usage-plans-and-rate-limits-in-the-sp-api).",
"parameters": [
{
"name": "processingStatuses",
"in": "query",
"description": "A list of processing statuses used to filter queries.",
"required": false,
"type": "array",
"minItems": 1,
"items": {
"type": "string",
"enum": [
"CANCELLED",
"DONE",
"FATAL",
"IN_PROGRESS",
"IN_QUEUE"
],
"x-docgen-enum-table-extension": [
{
"value": "CANCELLED",
"description": "The query was cancelled before it began processing."
},
{
"value": "DONE",
"description": "The query has completed processing."
},
{
"value": "FATAL",
"description": "The query was aborted due to a fatal error."
},
{
"value": "IN_PROGRESS",
"description": "The query is being processed."
},
{
"value": "IN_QUEUE",
"description": "The query has not yet started processing. It may be waiting for another `IN_PROGRESS` query."
}
]
}
},
{
"name": "pageSize",
"in": "query",
"description": "The maximum number of queries to return in a single call.",
"required": false,
"type": "integer",
"minimum": 1,
"maximum": 100,
"default": 10
},
{
"name": "createdSince",
"in": "query",
"description": "The earliest query creation date and time for queries to include in the response, in ISO 8601 date time format. The default is 90 days ago.",
"required": false,
"type": "string",
"format": "date-time"
},
{
"name": "createdUntil",
"in": "query",
"description": "The latest query creation date and time for queries to include in the response, in ISO 8601 date time format. The default is the time of the `getQueries` request.",
"required": false,
"type": "string",
"format": "date-time"
},
{
"name": "paginationToken",
"in": "query",
"description": "A token to fetch a certain page of results when there are multiple pages of results available. The value of this token is fetched from the `pagination.nextToken` field returned in the `GetQueriesResponse` object. All other parameters must be provided with the same values that were provided with the request that generated this token, with the exception of `pageSize` which can be modified between calls to `getQueries`. In the absence of this token value, `getQueries` returns the first page of results.",
"required": false,
"type": "string"
}
],
"responses": {
"200": {
"description": "Success.",
"schema": {
"$ref": "#/definitions/GetQueriesResponse"
},
"headers": {
"x-amzn-RateLimit-Limit": {
"description": "Your rate limit (requests per second) for this operation.",
"type": "string"
},
"x-amzn-RequestId": {
"type": "string",
"description": "Unique request reference identifier."
}
},
"x-amzn-api-sandbox": {
"static": [
{
"request": {
"parameters": {
"pageSize": {
"value": 1
},
"processingStatuses": {
"value": [
"DONE",
"IN_PROGRESS"
]
}
}
},
"response": {
"pagination": {
"nextToken": "NextToken1"
},
"queries": [
{
"queryId": "QueryId1",
"query": "query {sampleQuery(startDate:\"2023-03-01\" endDate:\"2023-03-31\" marketplaceIds:[\"ATVPDKIKX0DER\"]){sales{date averageSellingPrice{amount currencyCode}}}}",
"createdTime": "2023-12-11T13:47:20.677Z",
"processingStatus": "DONE",
"processingStartTime": "2023-12-11T13:47:20.677Z",
"processingEndTime": "2023-12-11T14:47:20.677Z",
"dataDocumentId": "DocumentId1"
}
]
}
},
{
"request": {
"parameters": {
"pageSize": {
"value": 1
},
"processingStatuses": {
"value": [
"DONE",
"IN_PROGRESS"
]
},
"paginationToken": {
"value": "NextToken1"
}
}
},
"response": {
"queries": [
{
"queryId": "QueryId2",
"query": "query {sampleQuery(startDate:\"2023-04-01\" endDate:\"2023-04-30\" marketplaceIds:[\"ATVPDKIKX0DER\"]){sales{date averageSellingPrice{amount currencyCode}}}}",
"createdTime": "2023-12-12T13:47:20.677Z",
"processingStatus": "IN_PROGRESS",
"processingStartTime": "2023-12-12T13:47:20.677Z"
}
]
}
}
]
}
},
"400": {
"description": "Request has missing or invalid parameters and cannot be parsed.",
"schema": {
"$ref": "#/definitions/ErrorList"
},
"headers": {
"x-amzn-RateLimit-Limit": {
"description": "Your rate limit (requests per second) for this operation.",
"type": "string"
},
"x-amzn-RequestId": {
"type": "string",
"description": "Unique request reference identifier."
}
},
"x-amzn-api-sandbox": {
"static": [
{
"request": {
"parameters": {
"processingStatuses": {
"value": [
"INVALID_STATUS"
]
}
}
},
"response": {
"errors": [
{
"code": "InvalidInput",
"message": "1 validation error detected: Value '[INVALID_STATUS]' at 'processingStatuses' failed to satisfy constraint: Member must satisfy constraint: [Member must satisfy enum value set: [DONE, FATAL, IN_PROGRESS, CANCELLED, IN_QUEUE]]",
"details": ""
}
]
}
}
]
}
},
"403": {
"description": "Indicates that access to the resource is forbidden. Possible reasons include Access Denied, Unauthorized, Expired Token, or Invalid Signature.",
"schema": {
"$ref": "#/definitions/ErrorList"
},
"headers": {
"x-amzn-RequestId": {
"type": "string",
"description": "Unique request reference identifier."
}
}
},
"404": {
"description": "The resource specified does not exist.",
"schema": {
"$ref": "#/definitions/ErrorList"
},
"headers": {
"x-amzn-RateLimit-Limit": {
"description": "Your rate limit (requests per second) for this operation.",
"type": "string"
},
"x-amzn-RequestId": {
"type": "string",
"description": "Unique request reference identifier."
}
}
},
"413": {
"description": "The request size exceeded the maximum accepted size.",
"schema": {
"$ref": "#/definitions/ErrorList"
},
"headers": {
"x-amzn-RequestId": {
"description": "Unique request reference identifier.",
"type": "string"
}
}
},
"415": {
"description": "The request payload is in an unsupported format.",
"schema": {
"$ref": "#/definitions/ErrorList"
},
"headers": {
"x-amzn-RequestId": {
"type": "string",
"description": "Unique request reference identifier."
}
}
},
"429": {
"description": "The frequency of requests was greater than allowed.",
"schema": {
"$ref": "#/definitions/ErrorList"
},
"headers": {
"x-amzn-RequestId": {
"type": "string",
"description": "Unique request reference identifier."
}
}
},
"500": {
"description": "An unexpected condition occurred that prevented the server from fulfilling the request.",
"schema": {
"$ref": "#/definitions/ErrorList"
},
"headers": {
"x-amzn-RequestId": {
"type": "string",
"description": "Unique request reference identifier."
}
}
},
"503": {
"description": "Temporary overloading or maintenance of the server.",
"schema": {
"$ref": "#/definitions/ErrorList"
},
"headers": {
"x-amzn-RequestId": {
"type": "string",
"description": "Unique request reference identifier."
}
}
}
}
},
"post": {
"tags": [
"queries"
],
"operationId": "createQuery",
"description": "Creates a Data Kiosk query request.\n\n**Note:** The retention of a query varies based on the fields requested. Each field within a schema is annotated with a `@resultRetention` directive that defines how long a query containing that field will be retained. When a query contains multiple fields with different retentions, the shortest (minimum) retention is applied. The retention of a query's resulting documents always matches the retention of the query.\n\n**Usage Plan:**\n\n| Rate (requests per second) | Burst |\n| ---- | ---- |\n| 0.0167 | 15 |\n\nThe `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](https://developer-docs.amazon.com/sp-api/docs/usage-plans-and-rate-limits-in-the-sp-api).",
"parameters": [
{
"name": "body",
"in": "body",
"description": "The body of the request.",
"required": true,
"schema": {
"$ref": "#/definitions/CreateQuerySpecification"
}
}
],
"responses": {
"202": {
"description": "Success.",
"schema": {
"$ref": "#/definitions/CreateQueryResponse"
},
"headers": {
"x-amzn-RateLimit-Limit": {
"description": "Your rate limit (requests per second) for this operation.",
"type": "string"
},
"x-amzn-RequestId": {
"type": "string",
"description": "Unique request reference identifier."
}
},
"x-amzn-api-sandbox": {
"static": [
{
"request": {
"parameters": {
"body": {
"value": {
"query": "query {sampleQuery(startDate:\"2023-03-01\" endDate:\"2023-03-31\" marketplaceIds:[\"ATVPDKIKX0DER\"]){sales{date averageSellingPrice{amount currencyCode}}}}"
}
}
}
},
"response": {
"queryId": "QueryId1"
}
}
]
}
},
"400": {
"description": "Request has missing or invalid parameters and cannot be parsed.",
"schema": {
"$ref": "#/definitions/ErrorList"
},
"headers": {
"x-amzn-RateLimit-Limit": {
"description": "Your rate limit (requests per second) for this operation.",
"type": "string"
},
"x-amzn-RequestId": {
"type": "string",
"description": "Unique request reference identifier."
}
},
"x-amzn-api-sandbox": {
"static": [
{
"request": {
"parameters": {
"body": {
"value": {
"query": "query {invalidSampleQuery(startDate:\"2023-03-01\" endDate:\"2023-03-31\" marketplaceIds:[\"ATVPDKIKX0DER\"]){sales{date averageSellingPrice{amount currencyCode}}}}"
}
}
}
},
"response": {
"errors": [
{
"code": "InvalidInput",
"message": "The provided query is invalid.",
"details": "Query 'invalidSampleQuery' is not supported."
}
]
}
}
]
}
},
"403": {
"description": "Indicates that access to the resource is forbidden. Possible reasons include Access Denied, Unauthorized, Expired Token, or Invalid Signature.",
"schema": {
"$ref": "#/definitions/ErrorList"
},
"headers": {
"x-amzn-RequestId": {
"type": "string",
"description": "Unique request reference identifier."
}
}
},
"404": {
"description": "The resource specified does not exist.",
"schema": {
"$ref": "#/definitions/ErrorList"
},
"headers": {
"x-amzn-RateLimit-Limit": {
"description": "Your rate limit (requests per second) for this operation.",
"type": "string"
},
"x-amzn-RequestId": {
"type": "string",
"description": "Unique request reference identifier."
}
}
},
"413": {
"description": "The request size exceeded the maximum accepted size.",
"schema": {
"$ref": "#/definitions/ErrorList"
},
"headers": {
"x-amzn-RequestId": {
"description": "Unique request reference identifier.",
"type": "string"
}
}
},
"415": {
"description": "The request payload is in an unsupported format.",
"schema": {
"$ref": "#/definitions/ErrorList"
},
"headers": {
"x-amzn-RequestId": {
"type": "string",
"description": "Unique request reference identifier."
}
}
},
"429": {
"description": "The frequency of requests was greater than allowed.",
"schema": {
"$ref": "#/definitions/ErrorList"
},
"headers": {
"x-amzn-RequestId": {
"type": "string",
"description": "Unique request reference identifier."
}
}
},
"500": {
"description": "An unexpected condition occurred that prevented the server from fulfilling the request.",
"schema": {
"$ref": "#/definitions/ErrorList"
},
"headers": {
"x-amzn-RequestId": {
"type": "string",
"description": "Unique request reference identifier."
}
}
},
"503": {
"description": "Temporary overloading or maintenance of the server.",
"schema": {
"$ref": "#/definitions/ErrorList"
},
"headers": {
"x-amzn-RequestId": {
"type": "string",
"description": "Unique request reference identifier."
}
}
}
}
},
"parameters": []
},
"/dataKiosk/2023-11-15/queries/{queryId}": {
"delete": {
"tags": [
"queries"
],
"operationId": "cancelQuery",
"description": "Cancels the query specified by the `queryId` parameter. Only queries with a non-terminal `processingStatus` (`IN_QUEUE`, `IN_PROGRESS`) can be cancelled. Cancelling a query that already has a `processingStatus` of `CANCELLED` will no-op. Cancelled queries are returned in subsequent calls to the `getQuery` and `getQueries` operations.\n\n**Usage Plan:**\n\n| Rate (requests per second) | Burst |\n| ---- | ---- |\n| 0.0222 | 10 |\n\nThe `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](https://developer-docs.amazon.com/sp-api/docs/usage-plans-and-rate-limits-in-the-sp-api).",
"parameters": [
{
"name": "queryId",
"in": "path",
"description": "The identifier for the query. This identifier is unique only in combination with a selling partner account ID.",
"required": true,
"type": "string"
}
],
"responses": {
"204": {
"description": "Success.",
"headers": {
"x-amzn-RateLimit-Limit": {
"description": "Your rate limit (requests per second) for this operation.",
"type": "string"
},
"x-amzn-RequestId": {
"type": "string",
"description": "Unique request reference identifier."
}
},
"x-amzn-api-sandbox": {
"static": [
{
"request": {
"parameters": {
"queryId": {
"value": "QueryId1"
}
}
},
"response": {}
}
]
}
},
"400": {
"description": "Request has missing or invalid parameters and cannot be parsed.",
"schema": {
"$ref": "#/definitions/ErrorList"
},
"headers": {
"x-amzn-RateLimit-Limit": {
"description": "Your rate limit (requests per second) for this operation.",
"type": "string"
},
"x-amzn-RequestId": {
"type": "string",
"description": "Unique request reference identifier."
}
},
"x-amzn-api-sandbox": {
"static": [
{
"request": {
"parameters": {
"queryId": {
"value": "InvalidQueryId1"
}
}
},
"response": {
"errors": [
{
"code": "InvalidInput",
"message": "Invalid input",
"details": "Invalid input"
}
]
}
}
]
}
},
"403": {
"description": "Indicates that access to the resource is forbidden. Possible reasons include Access Denied, Unauthorized, Expired Token, or Invalid Signature.",
"schema": {
"$ref": "#/definitions/ErrorList"
},
"headers": {
"x-amzn-RequestId": {
"type": "string",
"description": "Unique request reference identifier."
}
}
},
"404": {
"description": "The resource specified does not exist.",
"schema": {
"$ref": "#/definitions/ErrorList"
},
"headers": {
"x-amzn-RateLimit-Limit": {
"description": "Your rate limit (requests per second) for this operation.",
"type": "string"
},
"x-amzn-RequestId": {
"type": "string",
"description": "Unique request reference identifier."
}
},
"x-amzn-api-sandbox": {
"static": [
{
"request": {
"parameters": {
"queryId": {
"value": "NotFoundQueryId1"
}
}
},
"response": {
"errors": [
{
"code": "NotFound",
"message": "The provided queryId was not found."
}
]
}
}
]
}
},
"413": {
"description": "The request size exceeded the maximum accepted size.",
"schema": {
"$ref": "#/definitions/ErrorList"
},
"headers": {
"x-amzn-RequestId": {
"description": "Unique request reference identifier.",
"type": "string"
}
}
},
"415": {
"description": "The request payload is in an unsupported format.",
"schema": {
"$ref": "#/definitions/ErrorList"
},
"headers": {
"x-amzn-RequestId": {
"type": "string",
"description": "Unique request reference identifier."
}
}
},
"429": {
"description": "The frequency of requests was greater than allowed.",
"schema": {
"$ref": "#/definitions/ErrorList"
},
"headers": {
"x-amzn-RequestId": {
"type": "string",
"description": "Unique request reference identifier."
}
}
},
"500": {
"description": "An unexpected condition occurred that prevented the server from fulfilling the request.",
"schema": {
"$ref": "#/definitions/ErrorList"
},
"headers": {
"x-amzn-RequestId": {
"type": "string",
"description": "Unique request reference identifier."
}
}
},
"503": {
"description": "Temporary overloading or maintenance of the server.",
"schema": {
"$ref": "#/definitions/ErrorList"
},
"headers": {
"x-amzn-RequestId": {
"type": "string",
"description": "Unique request reference identifier."
}
}
}
}
},
"get": {
"tags": [
"queries"
],
"operationId": "getQuery",
"description": "Returns query details for the query specified by the `queryId` parameter. See the `createQuery` operation for details about query retention.\n\n**Usage Plan:**\n\n| Rate (requests per second) | Burst |\n| ---- | ---- |\n| 2.0 | 15 |\n\nThe `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](https://developer-docs.amazon.com/sp-api/docs/usage-plans-and-rate-limits-in-the-sp-api).",
"parameters": [
{
"name": "queryId",
"in": "path",
"required": true,
"description": "The query identifier.",
"type": "string"
}
],
"responses": {
"200": {
"description": "Success.",
"schema": {
"$ref": "#/definitions/Query"
},
"headers": {
"x-amzn-RateLimit-Limit": {
"description": "Your rate limit (requests per second) for this operation.",
"type": "string"
},
"x-amzn-RequestId": {
"type": "string",
"description": "Unique request reference identifier."
}
},
"x-amzn-api-sandbox": {
"static": [
{
"request": {
"parameters": {
"queryId": {
"value": "QueryId1"
}
}
},
"response": {
"queryId": "QueryId1",
"query": "query {sampleQuery(startDate:\"2023-03-01\" endDate:\"2023-03-31\" marketplaceIds:[\"ATVPDKIKX0DER\"]){sales{date averageSellingPrice{amount currencyCode}}}}",
"createdTime": "2023-12-11T13:47:20.677Z",
"processingStatus": "DONE",
"processingStartTime": "2023-12-11T13:47:20.677Z",
"processingEndTime": "2023-12-11T14:47:20.677Z",
"dataDocumentId": "DocumentId1"
}
}
]
}
},
"400": {
"description": "Request has missing or invalid parameters and cannot be parsed.",
"schema": {
"$ref": "#/definitions/ErrorList"
},
"headers": {
"x-amzn-RateLimit-Limit": {
"description": "Your rate limit (requests per second) for this operation.",
"type": "string"
},
"x-amzn-RequestId": {
"type": "string",
"description": "Unique request reference identifier."
}
},
"x-amzn-api-sandbox": {
"static": [
{
"request": {
"parameters": {
"queryId": {
"value": "InvalidQueryId1"
}
}
},
"response": {
"errors": [
{
"code": "InvalidInput",
"message": "Invalid input",
"details": "Invalid input"
}
]
}
}
]
}
},
"403": {
"description": "Indicates that access to the resource is forbidden. Possible reasons include Access Denied, Unauthorized, Expired Token, or Invalid Signature.",
"schema": {
"$ref": "#/definitions/ErrorList"
},
"headers": {
"x-amzn-RequestId": {
"type": "string",
"description": "Unique request reference identifier."
}
}
},
"404": {
"description": "The resource specified does not exist.",
"schema": {
"$ref": "#/definitions/ErrorList"
},
"headers": {
"x-amzn-RateLimit-Limit": {
"description": "Your rate limit (requests per second) for this operation.",
"type": "string"
},
"x-amzn-RequestId": {
"type": "string",
"description": "Unique request reference identifier."
}
},
"x-amzn-api-sandbox": {
"static": [
{
"request": {
"parameters": {
"queryId": {
"value": "NotFoundQueryId1"
}
}
},
"response": {
"errors": [
{
"code": "NotFound",
"message": "The provided queryId was not found."
}
]
}
}
]
}
},
"413": {
"description": "The request size exceeded the maximum accepted size.",
"schema": {
"$ref": "#/definitions/ErrorList"
},
"headers": {
"x-amzn-RequestId": {
"description": "Unique request reference identifier.",
"type": "string"
}
}
},
"415": {
"description": "The request payload is in an unsupported format.",
"schema": {
"$ref": "#/definitions/ErrorList"
},
"headers": {
"x-amzn-RequestId": {
"type": "string",
"description": "Unique request reference identifier."
}
}
},
"429": {
"description": "The frequency of requests was greater than allowed.",
"schema": {
"$ref": "#/definitions/ErrorList"
},
"headers": {
"x-amzn-RequestId": {
"type": "string",
"description": "Unique request reference identifier."
}
}
},
"500": {
"description": "An unexpected condition occurred that prevented the server from fulfilling the request.",
"schema": {
"$ref": "#/definitions/ErrorList"
},
"headers": {
"x-amzn-RequestId": {
"type": "string",
"description": "Unique request reference identifier."
}
}
},
"503": {
"description": "Temporary overloading or maintenance of the server.",
"schema": {
"$ref": "#/definitions/ErrorList"
},
"headers": {
"x-amzn-RequestId": {
"type": "string",
"description": "Unique request reference identifier."
}
}
}
}
},
"parameters": []
},
"/dataKiosk/2023-11-15/documents/{documentId}": {
"get": {
"tags": [
"queries"
],
"description": "Returns the information required for retrieving a Data Kiosk document's contents. See the `createQuery` operation for details about document retention.\n\n**Usage Plan:**\n\n| Rate (requests per second) | Burst |\n| ---- | ---- |\n| 0.0167 | 15 |\n\nThe `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](https://developer-docs.amazon.com/sp-api/docs/usage-plans-and-rate-limits-in-the-sp-api).",
"operationId": "getDocument",
"parameters": [
{
"name": "documentId",
"in": "path",
"description": "The identifier for the Data Kiosk document.",
"required": true,
"type": "string"
}
],
"responses": {
"200": {
"description": "Success.",
"schema": {
"$ref": "#/definitions/GetDocumentResponse"
},
"headers": {
"x-amzn-RateLimit-Limit": {
"description": "Your rate limit (requests per second) for this operation.",
"type": "string"
},
"x-amzn-RequestId": {
"type": "string",
"description": "Unique request reference identifier."
}
},
"x-amzn-api-sandbox": {
"static": [
{
"request": {
"parameters": {
"documentId": {
"value": "DocumentId1"
}
}
},
"response": {
"documentId": "DocumentId1",
"documentUrl": "https://d34o8swod1owfl.cloudfront.net/QUERY_DATA_OUTPUT_DOC.txt"
}
}
]
}
},
"400": {
"description": "Request has missing or invalid parameters and cannot be parsed.",
"schema": {
"$ref": "#/definitions/ErrorList"
},
"headers": {
"x-amzn-RateLimit-Limit": {
"description": "Your rate limit (requests per second) for this operation.",
"type": "string"
},
"x-amzn-RequestId": {
"type": "string",
"description": "Unique request reference identifier."
}
},
"x-amzn-api-sandbox": {
"static": [
{
"request": {
"parameters": {
"documentId": {
"value": "InvalidDocumentId1"
}
}
},
"response": {
"errors": [
{
"code": "InvalidInput",
"message": "Invalid input",
"details": "Invalid input"
}
]
}
}
]
}
},
"403": {
"description": "Indicates that access to the resource is forbidden. Possible reasons include Access Denied, Unauthorized, Expired Token, or Invalid Signature.",
"schema": {
"$ref": "#/definitions/ErrorList"
},
"headers": {
"x-amzn-RequestId": {
"type": "string",
"description": "Unique request reference identifier."
}
}
},
"404": {
"description": "The resource specified does not exist.",
"schema": {
"$ref": "#/definitions/ErrorList"
},
"headers": {
"x-amzn-RateLimit-Limit": {
"description": "Your rate limit (requests per second) for this operation.",
"type": "string"
},
"x-amzn-RequestId": {
"type": "string",
"description": "Unique request reference identifier."
}
},
"x-amzn-api-sandbox": {
"static": [
{
"request": {
"parameters": {
"documentId": {
"value": "NotFoundDocumentId1"
}
}
},
"response": {
"errors": [
{
"code": "NotFound",
"message": "The provided documentId was not found."
}
]
}
}
]
}
},
"413": {
"description": "The request size exceeded the maximum accepted size.",
"schema": {
"$ref": "#/definitions/ErrorList"
},
"headers": {
"x-amzn-RequestId": {
"description": "Unique request reference identifier.",
"type": "string"
}
}
},
"415": {
"description": "The request payload is in an unsupported format.",
"schema": {
"$ref": "#/definitions/ErrorList"
},
"headers": {
"x-amzn-RequestId": {
"type": "string",
"description": "Unique request reference identifier."
}
}
},
"429": {
"description": "The frequency of requests was greater than allowed.",
"schema": {
"$ref": "#/definitions/ErrorList"
},
"headers": {
"x-amzn-RequestId": {
"type": "string",
"description": "Unique request reference identifier."
}
}
},
"500": {
"description": "An unexpected condition occurred that prevented the server from fulfilling the request.",
"schema": {
"$ref": "#/definitions/ErrorList"
},
"headers": {
"x-amzn-RequestId": {
"type": "string",
"description": "Unique request reference identifier."
}
}
},
"503": {
"description": "Temporary overloading or maintenance of the server.",
"schema": {
"$ref": "#/definitions/ErrorList"
},
"headers": {
"x-amzn-RequestId": {
"type": "string",
"description": "Unique request reference identifier."
}
}
}
}
}
}
},
"definitions": {
"ErrorList": {
"type": "object",
"description": "A list of error responses returned when a request is unsuccessful.",
"required": [
"errors"
],
"properties": {
"errors": {
"description": "Error response returned when the request is unsuccessful.",
"type": "array",
"items": {
"$ref": "#/definitions/Error"
}
}
}
},
"Error": {
"type": "object",
"description": "Error response returned when the request is unsuccessful.",
"required": [
"code",
"message"
],
"properties": {
"code": {
"type": "string",
"description": "An error code that identifies the type of error that occurred."
},
"message": {
"type": "string",
"description": "A message that describes the error condition."
},
"details": {
"type": "string",
"description": "Additional details that can help the caller understand or fix the issue."
}
}
},
"Query": {
"type": "object",
"description": "Detailed information about the query.",
"required": [
"processingStatus",
"queryId",
"query",
"createdTime"
],
"properties": {
"queryId": {
"description": "The query identifier. This identifier is unique only in combination with a selling partner account ID.",
"type": "string"
},
"query": {
"description": "The submitted query.",
"type": "string"
},
"createdTime": {
"description": "The date and time when the query was created, in ISO 8601 date time format.",
"type": "string",
"format": "date-time"
},
"processingStatus": {
"description": "The processing status of the query.",
"type": "string",
"enum": [
"CANCELLED",
"DONE",
"FATAL",
"IN_PROGRESS",
"IN_QUEUE"
],
"x-docgen-enum-table-extension": [
{
"value": "CANCELLED",
"description": "The query was cancelled before it began processing."
},
{
"value": "DONE",
"description": "The query has completed processing."
},
{
"value": "FATAL",
"description": "The query was aborted due to a fatal error."
},
{
"value": "IN_PROGRESS",
"description": "The query is being processed."
},
{
"value": "IN_QUEUE",
"description": "The query has not yet started processing. It may be waiting for another `IN_PROGRESS` query."
}
]
},
"processingStartTime": {
"description": "The date and time when the query processing started, in ISO 8601 date time format.",
"type": "string",
"format": "date-time"
},
"processingEndTime": {
"description": "The date and time when the query processing completed, in ISO 8601 date time format.",
"type": "string",
"format": "date-time"
},
"dataDocumentId": {
"description": "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.",
"type": "string"
},
"errorDocumentId": {
"description": "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.",
"type": "string"
},
"pagination": {
"type": "object",
"description": "When a query produces results that are not included in the data document, pagination occurs. This means the results are divided into pages. To retrieve the next page, you must pass a `CreateQuerySpecification` object with `paginationToken` set to this object's `nextToken` and with `query` set to this object's `query` in the subsequent `createQuery` request. When there are no more pages to fetch, the `nextToken` field will be absent.",
"properties": {
"nextToken": {
"type": "string",
"description": "A token that can be used to fetch the next page of results."
}
}
}
}
},
"QueryList": {
"type": "array",
"description": "A list of queries.",
"items": {
"$ref": "#/definitions/Query"
}
},
"CreateQuerySpecification": {
"type": "object",
"description": "Information required to create the query.",
"required": [
"query"
],
"properties": {
"query": {
"description": "The GraphQL query to submit. A query must be at most 8000 characters after unnecessary whitespace is removed.",
"type": "string"
},
"paginationToken":{
"description": "A token to fetch a certain page of query results when there are multiple pages of query results available. The value of this token must be fetched from the `pagination.nextToken` field of the `Query` object, and the `query` field for this object must also be set to the `query` field of the same `Query` object. A `Query` object can be retrieved from either the `getQueries` or `getQuery` operation. In the absence of this token value, the first page of query results will be requested.",
"type": "string"
}
}
},
"CreateQueryResponse": {
"type": "object",
"description": "The response for the `createQuery` operation.",
"required": [
"queryId"
],
"properties": {
"queryId": {
"description": "The identifier for the query. This identifier is unique only in combination with a selling partner account ID.",
"type": "string"
}
}
},
"GetQueriesResponse": {
"type": "object",
"description": "The response for the `getQueries` operation.",
"required": [
"queries"
],
"properties": {
"queries": {
"description": "The Data Kiosk queries.",
"$ref": "#/definitions/QueryList"
},
"pagination": {
"type": "object",
"description": "When a request has results that are not included in this response, pagination occurs. This means the results are divided into pages. To retrieve the next page, you must pass the `nextToken` as the `paginationToken` query parameter in the subsequent `getQueries` request. All other parameters must be provided with the same values that were provided with the request that generated this token, with the exception of `pageSize` which can be modified between calls to `getQueries`. When there are no more pages to fetch, the `nextToken` field will be absent.",
"properties": {
"nextToken": {
"type": "string",
"description": "A token that can be used to fetch the next page of results."
}
}
}
}
},
"GetDocumentResponse": {
"type": "object",
"description": "The response for the `getDocument` operation.",
"required": [
"documentId",
"documentUrl"
],
"properties": {
"documentId": {
"description": "The identifier for the Data Kiosk document. This identifier is unique only in combination with a selling partner account ID.",
"type": "string"
},
"documentUrl": {
"description": "A presigned URL that can be used to retrieve the Data Kiosk document. This URL expires after 5 minutes. If the Data Kiosk document is compressed, the `Content-Encoding` header will indicate the compression algorithm.\n\n**Note:** Most HTTP clients are capable of automatically decompressing downloaded files based on the `Content-Encoding` header.",
"type": "string"
}
}
}
},
"basePath": "/"
}
Updated about 1 month ago