Variable dataKioskQueryProcessingFinishedNotificationConst

Type declaration

• Readonlydescription: "This notification is delivered when a Data Kiosk query finishes processing."

• Readonlyexamples: readonly [
      {
          eventTime: "2023-12-23T21:30:13.713Z";
          notificationMetadata: {
              applicationId: "amzn1.sellerapps.app.aacccfff-4455-4b7c-4422-664ecacdd336";
              notificationId: "d0e9e693-c3ad-4373-979f-ed4ec98dd746";
              publishTime: "2023-12-23T21:30:16.903Z";
              subscriptionId: "subscription-id-d0e9e693-c3ad-4373-979f-ed4ec98dd746";
          };
          notificationType: "DATA_KIOSK_QUERY_PROCESSING_FINISHED";
          notificationVersion: "2023-11-15";
          payload: {
              accountId: "amzn1.merchant.o.A21CXK3C4ERTY8";
              dataDocumentId: "amzn1.tortuga.3.edbcd0d8-3434-8222-1234-52ad8ade1208.REP4567URI9BMZ";
              pagination: {
                  nextToken: "AAMA-EFRSURBSGhKZlpVSWVwOW96aU1xa2p6amVJdGp1YlZxMndOelFXa2hydStrUjZvVmFRRWVINldMNnFUVz";
              };
              processingStatus: "DONE";
              query: "query MyQuery{salesAndTrafficByDate(startDate:\"2023-05-01\" endDate:\"2023-06-01\" aggregateBy:DAY){marketplaceId startDate endDate sales{unitsOrdered}traffic{pageViews}}}";
              queryId: "54517018502";
          };
          payloadVersion: "2023-11-15";
      },
  ]

• Readonlyproperties: {
      eventTime: {
          $id: "#/properties/eventTime";
          description: "The time the notification was sent in ISO 8601 format.";
          examples: readonly ["2023-12-23T21:30:13.713Z"];
          type: "string";
      };
      notificationMetadata: {
          $id: "#/properties/notificationMetadata";
          description: "The notification's metadata.";
          examples: readonly [
              {
                  applicationId: "amzn1.sellerapps.app.aacccfff-4455-4b7c-4422-664ecacdd336";
                  notificationId: "d0e9e693-c3ad-4373-979f-ed4ec98dd746";
                  publishTime: "2023-12-23T21:30:16.903Z";
                  subscriptionId: "subscription-id-d0e9e693-c3ad-4373-979f-ed4ec98dd746";
              },
          ];
          properties: {
              applicationId: {
                  $id: "#/properties/notificationMetadata/properties/applicationId";
                  description: "The application identifier.";
                  examples: readonly [
                      "amzn1.sellerapps.app.aacccfff-4455-4b7c-4422-664ecacdd336",
                  ];
                  type: "string";
              };
              notificationId: {
                  $id: "#/properties/notificationMetadata/properties/notificationId";
                  description: "The notification identifier.";
                  examples: readonly ["d0e9e693-c3ad-4373-979f-ed4ec98dd746"];
                  type: "string";
              };
              publishTime: {
                  $id: "#/properties/notificationMetadata/properties/publishTime";
                  description: "The time the notification was published in ISO 8601 format.";
                  examples: readonly ["2023-12-23T21:30:16.903Z"];
                  type: "string";
              };
              subscriptionId: {
                  $id: "#/properties/notificationMetadata/properties/subscriptionId";
                  description: "The subscription identifier.";
                  examples: readonly [
                      "subscription-id-d0e9e693-c3ad-4373-979f-ed4ec98dd746",
                  ];
                  type: "string";
              };
          };
          required: readonly [
              "applicationId",
              "subscriptionId",
              "publishTime",
              "notificationId",
          ];
          type: "object";
      };
      notificationType: {
          $id: "#/properties/notificationType";
          description: "The notification type.";
          examples: readonly ["DATA_KIOSK_QUERY_PROCESSING_FINISHED"];
          type: "string";
      };
      notificationVersion: {
          $id: "#/properties/notificationVersion";
          description: "The notification version.";
          examples: readonly ["2023-11-15"];
          type: "string";
      };
      payload: {
          $id: "#/properties/payload";
          description: "The Data Kiosk query processing notification payload.";
          examples: readonly [
              {
                  accountId: "amzn1.merchant.o.A21CXK3C4ERTY8";
                  dataDocumentId: "amzn1.tortuga.3.edbcd0d8-3434-8222-1234-52ad8ade1208.REP4567URI9BMZ";
                  pagination: {
                      nextToken: "AAMA-EFRSURBSGhKZlpVSWVwOW96aU1xa2p6amVJdGp1YlZxMndOelFXa2hydStrUjZvVmFRRWVINldMNnFUVz";
                  };
                  processingStatus: "DONE";
                  query: "query MyQuery{salesAndTrafficByDate(startDate:\"2023-05-01\" endDate:\"2023-06-01\" aggregateBy:DAY){marketplaceId startDate endDate sales{unitsOrdered}traffic{pageViews}}}";
                  queryId: "54517018502";
              },
              {
                  accountId: "amzn1.merchant.o.A21CXK3C4ERTY8";
                  dataDocumentId: "amzn1.tortuga.3.edbcd0d8-3434-8222-1234-52ad8ade1208.REP4567URI9BMZ";
                  processingStatus: "DONE";
                  query: "query MyQuery{salesAndTrafficByDate(startDate:\"2023-05-01\" endDate:\"2023-06-01\" aggregateBy:DAY){marketplaceId startDate endDate sales{unitsOrdered}traffic{pageViews}}}";
                  queryId: "54517018502";
              },
              {
                  accountId: "amzn1.merchant.o.A21CXK3C4ERTY8";
                  processingStatus: "DONE";
                  query: "query MyQuery{salesAndTrafficByDate(startDate:\"2023-05-01\" endDate:\"2023-06-01\" aggregateBy:DAY){marketplaceId startDate endDate sales{unitsOrdered}traffic{pageViews}}}";
                  queryId: "54517018502";
              },
              {
                  accountId: "amzn1.merchant.o.A21CXK3C4ERTY8";
                  processingStatus: "CANCELLED";
                  query: "query MyQuery{salesAndTrafficByDate(startDate:\"2023-05-01\" endDate:\"2023-06-01\" aggregateBy:DAY){marketplaceId startDate endDate sales{unitsOrdered}traffic{pageViews}}}";
                  queryId: "54517018502";
              },
              {
                  accountId: "amzn1.merchant.o.A21CXK3C4ERTY8";
                  errorDocumentId: "amzn1.tortuga.3.edbcd0d8-3434-8222-1234-52ad8ade1208.REP4567URI9BMZ";
                  processingStatus: "FATAL";
                  query: "query MyQuery{salesAndTrafficByDate(startDate:\"2023-05-01\" endDate:\"2023-06-01\" aggregateBy:DAY){marketplaceId startDate endDate sales{unitsOrdered}traffic{pageViews}}}";
                  queryId: "54517018502";
              },
          ];
          properties: {
              accountId: {
                  $id: "#/properties/payload/properties/accountId";
                  description: "The merchant customer identifier or vendor group identifier of the selling partner account on whose behalf the query was submitted.";
                  examples: readonly [
                      "amzn1.merchant.o.A21CXK3C4ERTY8",
                      "amzn1.vg.6213651",
                  ];
                  type: "string";
              };
              dataDocumentId: {
                  $id: "#/properties/payload/properties/dataDocumentId";
                  description: "The data document identifier. This document identifier is only present when there is data available as a result of the query. This identifier is unique only in combination with the `accountId`. Pass this identifier into the `getDocument` operation to get the information required to retrieve the data document's contents.";
                  examples: readonly [
                      "amzn1.tortuga.3.edbcd0d8-3434-8222-1234-52ad8ade1208.REP4567URI9BMZ",
                  ];
                  type: "string";
              };
              errorDocumentId: {
                  $id: "#/properties/payload/properties/errorDocumentId";
                  description: "The error document identifier. This document identifier is only present when an error occurs during query processing. This identifier is unique only in combination with the `accountId`. Pass this identifier into the `getDocument` operation to get the information required to retrieve the error document's contents.";
                  examples: readonly [
                      "amzn1.tortuga.3.edbcd0d8-3434-8222-1234-52ad8ade1208.REP4567URI9BMZ",
                  ];
                  type: "string";
              };
              pagination: {
                  $id: "#/properties/payload/properties/pagination";
                  description: "When a query produces results that are not included in the data document, pagination occurs. This means that 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.";
                  examples: readonly [
                      {
                          nextToken: "AAMA-EFRSURBSGhKZlpVSWVwOW96aU1xa2p6amVJdGp1YlZxMndOelFXa2hydStrUjZvVmFRRWVINldMNnFUVz";
                      },
                  ];
                  properties: {
                      nextToken: {
                          $id: "#/properties/payload/properties/pagination/properties/nextToken";
                          description: "A token that can be used to fetch the next page of results.";
                          examples: readonly [
                              "AAMA-EFRSURBSGhKZlpVSWVwOW96aU1xa2p6amVJdGp1YlZxMndOelFXa2hydStrUjZvVmFRRWVINldMNnFUVz",
                          ];
                          type: "string";
                      };
                  };
                  type: "object";
              };
              processingStatus: {
                  $id: "#/properties/payload/properties/processingStatus";
                  description: "The processing status of the query.";
                  enum: readonly ["CANCELLED", "DONE", "FATAL"];
                  examples: readonly ["CANCELLED", "DONE", "FATAL"];
                  type: "string";
              };
              query: {
                  $id: "#/properties/payload/properties/query";
                  description: "The submitted query.";
                  examples: readonly [
                      "query MyQuery{salesAndTrafficByDate(startDate:\"2023-05-01\" endDate:\"2023-06-01\" aggregateBy:DAY){marketplaceId startDate endDate sales{unitsOrdered}traffic{pageViews}}}",
                  ];
                  type: "string";
              };
              queryId: {
                  $id: "#/properties/payload/properties/queryId";
                  description: "The query identifier. This identifier is unique only in combination with the `accountId`.";
                  examples: readonly ["54517018502"];
                  type: "string";
              };
          };
          required: readonly ["accountId", "queryId", "query", "processingStatus"];
          type: "object";
      };
      payloadVersion: {
          $id: "#/properties/payloadVersion";
          description: "The payload version of the notification.";
          examples: readonly ["2023-11-15"];
          type: "string";
      };
  }

• Readonlyrequired: readonly [
      "notificationVersion",
      "notificationType",
      "payloadVersion",
      "eventTime",
      "payload",
      "notificationMetadata",
  ]

• Readonlytitle: "Data Kiosk Query Processing Finished Notification."

• Readonlytype: "object"