diff --git a/models/data-kiosk-api-model/dataKiosk_2023-11-15.json b/models/data-kiosk-api-model/dataKiosk_2023-11-15.json index 50d3474..2b02ee9 100644 --- a/models/data-kiosk-api-model/dataKiosk_2023-11-15.json +++ b/models/data-kiosk-api-model/dataKiosk_2023-11-15.json @@ -127,29 +127,62 @@ { "request": { "parameters": { + "pageSize": { + "value": 1 + }, "processingStatuses": { - "value": [ - "IN_QUEUE", - "IN_PROGRESS" - ] + "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" + } + ] } }, - "response": { - "pagination": { - "nextToken": "VGhpcyB0b2tlbiBpcyBvcGFxdWUgYW5kIGludGVudGlvbmFsbHkgb2JmdXNjYXRlZA==" - }, - "queries": [ - { - "queryId": "QueryId1", - "query": "query {sampleQuery(startDate:\"2022-03-12\" endDate:\"2022-03-20\" marketplaceIds:[\"ATVPDKIKX0DER\"]){sales{date averageSellingPrice{amount currencyCode}}}}", - "createdTime": "2019-12-10T13:47:20.677Z", - "processingStatus": "IN_PROGRESS", - "processingStartTime": "2019-12-10T13:47:20.677Z", - "processingEndTime": "2019-12-12T13:47:20.677Z" + { + "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" + } + ] + } } ] } @@ -176,12 +209,11 @@ "parameters": { "processingStatuses": { "value": [ - "INVALID_STATUS", - "IN_PROGRESS" + "INVALID_STATUS" ] + } } - } - }, + }, "response": { "errors": [ { @@ -195,22 +227,6 @@ ] } }, - "401": { - "description": "The request's Authorization header is not formatted correctly or does not contain a valid token.", - "schema": { - "$ref": "#/definitions/ErrorList" - }, - "headers": { - "x-amzn-RateLimit-Limit": { - "description": "Your rate limit (requests per second) for this operation.\n_Note:_ For this status code, the rate limit header is deprecated and no longer returned.", - "type": "string" - }, - "x-amzn-RequestId": { - "type": "string", - "description": "Unique request reference identifier." - } - } - }, "403": { "description": "Indicates that access to the resource is forbidden. Possible reasons include Access Denied, Unauthorized, Expired Token, or Invalid Signature.", "schema": { @@ -224,7 +240,7 @@ } }, "404": { - "description": "The specified resource does not exist.", + "description": "The resource specified does not exist.", "schema": { "$ref": "#/definitions/ErrorList" }, @@ -239,16 +255,24 @@ } } }, - "415": { - "description": "The request's Content-Type header is invalid.", + "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-RateLimit-Limit": { - "description": "Your rate limit (requests per second) for this operation.\n_Note:_ For this status code, the rate limit header is deprecated and no longer returned.", - "type": "string" - }, "x-amzn-RequestId": { "type": "string", "description": "Unique request reference identifier." @@ -261,10 +285,6 @@ "$ref": "#/definitions/ErrorList" }, "headers": { - "x-amzn-RateLimit-Limit": { - "description": "Your rate limit (requests per second) for this operation.\n_Note:_ For this status code, the rate limit header is deprecated and no longer returned.", - "type": "string" - }, "x-amzn-RequestId": { "type": "string", "description": "Unique request reference identifier." @@ -277,10 +297,6 @@ "$ref": "#/definitions/ErrorList" }, "headers": { - "x-amzn-RateLimit-Limit": { - "description": "Your rate limit (requests per second) for this operation.\n_Note:_ For this status code, the rate limit header is deprecated and no longer returned.", - "type": "string" - }, "x-amzn-RequestId": { "type": "string", "description": "Unique request reference identifier." @@ -293,10 +309,6 @@ "$ref": "#/definitions/ErrorList" }, "headers": { - "x-amzn-RateLimit-Limit": { - "description": "Your rate limit (requests per second) for this operation.\n_Note:_ For this status code, the rate limit header is deprecated and no longer returned.", - "type": "string" - }, "x-amzn-RequestId": { "type": "string", "description": "Unique request reference identifier." @@ -315,6 +327,7 @@ { "name": "body", "in": "body", + "description": "The body of the request.", "required": true, "schema": { "$ref": "#/definitions/CreateQuerySpecification" @@ -344,7 +357,7 @@ "parameters": { "body": { "value": { - "query": "query {sampleQuery(startDate:\"2022-03-12\" endDate:\"2022-03-20\" marketplaceIds:[\"ATVPDKIKX0DER\"]){sales{date averageSellingPrice{amount currencyCode}}}}" + "query": "query {sampleQuery(startDate:\"2023-03-01\" endDate:\"2023-03-31\" marketplaceIds:[\"ATVPDKIKX0DER\"]){sales{date averageSellingPrice{amount currencyCode}}}}" } } } @@ -378,17 +391,17 @@ "parameters": { "body": { "value": { - "query": "query {invalidSampleQuery(startDate:\"2022-03-12\" endDate:\"2022-03-20\" marketplaceIds:[\"ATVPDKIKX0DER\"]){sales{date averageSellingPrice{amount currencyCode}}}}" + "query": "query {invalidSampleQuery(startDate:\"2023-03-01\" endDate:\"2023-03-31\" marketplaceIds:[\"ATVPDKIKX0DER\"]){sales{date averageSellingPrice{amount currencyCode}}}}" + } } } - } - }, + }, "response": { "errors": [ { - "code": "400", - "message": "Invalid input", - "details": "Invalid input" + "code": "InvalidInput", + "message": "The provided query is invalid.", + "details": "Query 'invalidSampleQuery' is not supported." } ] } @@ -396,22 +409,6 @@ ] } }, - "401": { - "description": "The request's Authorization header is not formatted correctly or does not contain a valid token.", - "schema": { - "$ref": "#/definitions/ErrorList" - }, - "headers": { - "x-amzn-RateLimit-Limit": { - "description": "Your rate limit (requests per second) for this operation.\n_Note:_ For this status code, the rate limit header is deprecated and no longer returned.", - "type": "string" - }, - "x-amzn-RequestId": { - "type": "string", - "description": "Unique request reference identifier." - } - } - }, "403": { "description": "Indicates that access to the resource is forbidden. Possible reasons include Access Denied, Unauthorized, Expired Token, or Invalid Signature.", "schema": { @@ -425,7 +422,7 @@ } }, "404": { - "description": "The specified resource does not exist.", + "description": "The resource specified does not exist.", "schema": { "$ref": "#/definitions/ErrorList" }, @@ -440,16 +437,24 @@ } } }, - "415": { - "description": "The request's Content-Type header is invalid.", + "413": { + "description": "The request size exceeded the maximum accepted size.", "schema": { "$ref": "#/definitions/ErrorList" }, "headers": { - "x-amzn-RateLimit-Limit": { - "description": "Your rate limit (requests per second) for this operation.\n_Note:_ For this status code, the rate limit header is deprecated and no longer returned.", + "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." @@ -462,10 +467,6 @@ "$ref": "#/definitions/ErrorList" }, "headers": { - "x-amzn-RateLimit-Limit": { - "description": "Your rate limit (requests per second) for this operation.\n_Note:_ For this status code, the rate limit header is deprecated and no longer returned.", - "type": "string" - }, "x-amzn-RequestId": { "type": "string", "description": "Unique request reference identifier." @@ -478,10 +479,6 @@ "$ref": "#/definitions/ErrorList" }, "headers": { - "x-amzn-RateLimit-Limit": { - "description": "Your rate limit (requests per second) for this operation.\n_Note:_ For this status code, the rate limit header is deprecated and no longer returned.", - "type": "string" - }, "x-amzn-RequestId": { "type": "string", "description": "Unique request reference identifier." @@ -494,10 +491,6 @@ "$ref": "#/definitions/ErrorList" }, "headers": { - "x-amzn-RateLimit-Limit": { - "description": "Your rate limit (requests per second) for this operation.\n_Note:_ For this status code, the rate limit header is deprecated and no longer returned.", - "type": "string" - }, "x-amzn-RequestId": { "type": "string", "description": "Unique request reference identifier." @@ -525,7 +518,7 @@ } ], "responses": { - "200": { + "204": { "description": "Success.", "headers": { "x-amzn-RateLimit-Limit": { @@ -546,7 +539,8 @@ "value": "QueryId1" } } - } + }, + "response": {} } ] } @@ -570,12 +564,16 @@ "static": [ { "request": { - "parameters": {} + "parameters": { + "queryId": { + "value": "InvalidQueryId1" + } + } }, "response": { "errors": [ { - "code": "400", + "code": "InvalidInput", "message": "Invalid input", "details": "Invalid input" } @@ -585,22 +583,6 @@ ] } }, - "401": { - "description": "The request's Authorization header is not formatted correctly or does not contain a valid token.", - "schema": { - "$ref": "#/definitions/ErrorList" - }, - "headers": { - "x-amzn-RateLimit-Limit": { - "description": "Your rate limit (requests per second) for this operation.\n_Note:_ For this status code, the rate limit header is deprecated and no longer returned.", - "type": "string" - }, - "x-amzn-RequestId": { - "type": "string", - "description": "Unique request reference identifier." - } - } - }, "403": { "description": "Indicates that access to the resource is forbidden. Possible reasons include Access Denied, Unauthorized, Expired Token, or Invalid Signature.", "schema": { @@ -614,7 +596,7 @@ } }, "404": { - "description": "The specified resource does not exist.", + "description": "The resource specified does not exist.", "schema": { "$ref": "#/definitions/ErrorList" }, @@ -627,18 +609,47 @@ "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." + } + ] + } + } + ] } }, - "415": { - "description": "The request's Content-Type header is invalid.", + "413": { + "description": "The request size exceeded the maximum accepted size.", "schema": { "$ref": "#/definitions/ErrorList" }, "headers": { - "x-amzn-RateLimit-Limit": { - "description": "Your rate limit (requests per second) for this operation.\n_Note:_ For this status code, the rate limit header is deprecated and no longer returned.", + "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." @@ -651,10 +662,6 @@ "$ref": "#/definitions/ErrorList" }, "headers": { - "x-amzn-RateLimit-Limit": { - "description": "Your rate limit (requests per second) for this operation.\n_Note:_ For this status code, the rate limit header is deprecated and no longer returned.", - "type": "string" - }, "x-amzn-RequestId": { "type": "string", "description": "Unique request reference identifier." @@ -667,10 +674,6 @@ "$ref": "#/definitions/ErrorList" }, "headers": { - "x-amzn-RateLimit-Limit": { - "description": "Your rate limit (requests per second) for this operation.\n_Note:_ For this status code, the rate limit header is deprecated and no longer returned.", - "type": "string" - }, "x-amzn-RequestId": { "type": "string", "description": "Unique request reference identifier." @@ -683,10 +686,6 @@ "$ref": "#/definitions/ErrorList" }, "headers": { - "x-amzn-RateLimit-Limit": { - "description": "Your rate limit (requests per second) for this operation.\n_Note:_ For this status code, the rate limit header is deprecated and no longer returned.", - "type": "string" - }, "x-amzn-RequestId": { "type": "string", "description": "Unique request reference identifier." @@ -738,11 +737,12 @@ }, "response": { "queryId": "QueryId1", - "query": "query {sampleQuery(startDate:\"2022-03-12\" endDate:\"2022-03-20\" marketplaceIds:[\"ATVPDKIKX0DER\"]){sales{date averageSellingPrice{amount currencyCode}}}}", - "createdTime": "2019-12-10T13:47:20.677Z", - "processingStatus": "IN_PROGRESS", - "processingStartTime": "2019-12-10T13:47:20.677Z", - "processingEndTime": "2019-12-12T13:47:20.677Z" + "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" } } ] @@ -776,8 +776,9 @@ "response": { "errors": [ { - "code": "NotFound", - "message": "The provided queryId was not found." + "code": "InvalidInput", + "message": "Invalid input", + "details": "Invalid input" } ] } @@ -785,22 +786,6 @@ ] } }, - "401": { - "description": "The request's Authorization header is not formatted correctly or does not contain a valid token.", - "schema": { - "$ref": "#/definitions/ErrorList" - }, - "headers": { - "x-amzn-RateLimit-Limit": { - "description": "Your rate limit (requests per second) for this operation.\n_Note:_ For this status code, the rate limit header is deprecated and no longer returned.", - "type": "string" - }, - "x-amzn-RequestId": { - "type": "string", - "description": "Unique request reference identifier." - } - } - }, "403": { "description": "Indicates that access to the resource is forbidden. Possible reasons include Access Denied, Unauthorized, Expired Token, or Invalid Signature.", "schema": { @@ -814,7 +799,7 @@ } }, "404": { - "description": "The specified resource does not exist.", + "description": "The resource specified does not exist.", "schema": { "$ref": "#/definitions/ErrorList" }, @@ -827,18 +812,47 @@ "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." + } + ] + } + } + ] } }, - "415": { - "description": "The request's Content-Type header is invalid.", + "413": { + "description": "The request size exceeded the maximum accepted size.", "schema": { "$ref": "#/definitions/ErrorList" }, "headers": { - "x-amzn-RateLimit-Limit": { - "description": "Your rate limit (requests per second) for this operation.\n_Note:_ For this status code, the rate limit header is deprecated and no longer returned.", + "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." @@ -851,10 +865,6 @@ "$ref": "#/definitions/ErrorList" }, "headers": { - "x-amzn-RateLimit-Limit": { - "description": "Your rate limit (requests per second) for this operation.\n_Note:_ For this status code, the rate limit header is deprecated and no longer returned.", - "type": "string" - }, "x-amzn-RequestId": { "type": "string", "description": "Unique request reference identifier." @@ -867,10 +877,6 @@ "$ref": "#/definitions/ErrorList" }, "headers": { - "x-amzn-RateLimit-Limit": { - "description": "Your rate limit (requests per second) for this operation.\n_Note:_ For this status code, the rate limit header is deprecated and no longer returned.", - "type": "string" - }, "x-amzn-RequestId": { "type": "string", "description": "Unique request reference identifier." @@ -883,10 +889,6 @@ "$ref": "#/definitions/ErrorList" }, "headers": { - "x-amzn-RateLimit-Limit": { - "description": "Your rate limit (requests per second) for this operation.\n_Note:_ For this status code, the rate limit header is deprecated and no longer returned.", - "type": "string" - }, "x-amzn-RequestId": { "type": "string", "description": "Unique request reference identifier." @@ -926,7 +928,7 @@ }, "x-amzn-RequestId": { "type": "string", - "description": "Unique request reference ID." + "description": "Unique request reference identifier." } }, "x-amzn-api-sandbox": { @@ -935,12 +937,12 @@ "request": { "parameters": { "documentId": { - "value": "0356cf79-b8b0-4226-b4b9-0ee058ea5760" + "value": "DocumentId1" } } }, "response": { - "documentId": "0356cf79-b8b0-4226-b4b9-0ee058ea5760", + "documentId": "DocumentId1", "documentUrl": "https://d34o8swod1owfl.cloudfront.net/QUERY_DATA_OUTPUT_DOC.txt" } } @@ -959,7 +961,7 @@ }, "x-amzn-RequestId": { "type": "string", - "description": "Unique request reference ID." + "description": "Unique request reference identifier." } }, "x-amzn-api-sandbox": { @@ -975,8 +977,9 @@ "response": { "errors": [ { - "code": "NotFound", - "message": "The provided documentId was not found." + "code": "InvalidInput", + "message": "Invalid input", + "details": "Invalid input" } ] } @@ -984,36 +987,20 @@ ] } }, - "401": { - "description": "The request's Authorization header is not formatted correctly or does not contain a valid token.", - "schema": { - "$ref": "#/definitions/ErrorList" - }, - "headers": { - "x-amzn-RateLimit-Limit": { - "description": "Your rate limit (requests per second) for this operation.\n_Note:_ For this status code, the rate limit header is deprecated and no longer returned.", - "type": "string" - }, - "x-amzn-RequestId": { - "type": "string", - "description": "Unique request reference ID." - } - } - }, "403": { - "description": "Indicates access to the resource is forbidden. Possible reasons include Access Denied, Unauthorized, Expired Token, or Invalid Signature.", + "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 ID." + "description": "Unique request reference identifier." } } }, "404": { - "description": "The specified resource does not exist.", + "description": "The resource specified does not exist.", "schema": { "$ref": "#/definitions/ErrorList" }, @@ -1024,20 +1011,49 @@ }, "x-amzn-RequestId": { "type": "string", - "description": "Unique request reference ID." + "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." + } + ] + } + } + ] } }, - "415": { - "description": "The request's Content-Type header is invalid.", + "413": { + "description": "The request size exceeded the maximum accepted size.", "schema": { "$ref": "#/definitions/ErrorList" }, "headers": { - "x-amzn-RateLimit-Limit": { - "description": "Your rate limit (requests per second) for this operation.\n_Note:_ For this status code, the rate limit header is deprecated and no longer returned.", + "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." @@ -1050,13 +1066,9 @@ "$ref": "#/definitions/ErrorList" }, "headers": { - "x-amzn-RateLimit-Limit": { - "description": "Your rate limit (requests per second) for this operation.\n_Note:_ For this status code, the rate limit header is deprecated and no longer returned.", - "type": "string" - }, "x-amzn-RequestId": { "type": "string", - "description": "Unique request reference ID." + "description": "Unique request reference identifier." } } }, @@ -1066,13 +1078,9 @@ "$ref": "#/definitions/ErrorList" }, "headers": { - "x-amzn-RateLimit-Limit": { - "description": "Your rate limit (requests per second) for this operation.\n_Note:_ For this status code, the rate limit header is deprecated and no longer returned.", - "type": "string" - }, "x-amzn-RequestId": { "type": "string", - "description": "Unique request reference ID." + "description": "Unique request reference identifier." } } }, @@ -1082,13 +1090,9 @@ "$ref": "#/definitions/ErrorList" }, "headers": { - "x-amzn-RateLimit-Limit": { - "description": "Your rate limit (requests per second) for this operation.\n_Note:_ For this status code, the rate limit header is deprecated and no longer returned.", - "type": "string" - }, "x-amzn-RequestId": { "type": "string", - "description": "Unique request reference ID." + "description": "Unique request reference identifier." } } } @@ -1105,6 +1109,7 @@ ], "properties": { "errors": { + "description": "Error response returned when the request is unsuccessful.", "type": "array", "items": { "$ref": "#/definitions/Error" @@ -1126,7 +1131,7 @@ }, "message": { "type": "string", - "description": "A message that describes the error condition in a human-readable form." + "description": "A message that describes the error condition." }, "details": { "type": "string", @@ -1300,4 +1305,4 @@ } }, "basePath": "/" -} +} \ No newline at end of file