docs(client-supplychain): Update API documentation to clarify the eve…

…nt SLA as well as the data model expectations
aws · Aug 23, 2024 · f7b618c · f7b618c
1 parent ee762fe
commit f7b618c
Show file tree

Hide file tree

Showing 3 changed files with 6 additions and 4 deletions.
diff --git a/clients/client-supplychain/src/commands/SendDataIntegrationEventCommand.ts b/clients/client-supplychain/src/commands/SendDataIntegrationEventCommand.ts
@@ -32,7 +32,8 @@ export interface SendDataIntegrationEventCommandInput extends SendDataIntegratio
 export interface SendDataIntegrationEventCommandOutput extends SendDataIntegrationEventResponse, __MetadataBearer {}
 
 /**
- * <p>Send transactional data events with real-time data for analysis or monitoring.</p>
+ * <p>Send the transactional data payload for the event with real-time data for analysis or monitoring. The real-time data events are stored in an Amazon Web Services service before being processed and stored in data lake.
+ *             New data events are synced with data lake at 5 PM GMT everyday. The updated transactional data is available in data lake after ingestion.</p>
  * @example
  * Use a bare-bones client and the command you need to make an API call.
  * ```javascript

diff --git a/clients/client-supplychain/src/models/models_0.ts b/clients/client-supplychain/src/models/models_0.ts
@@ -311,7 +311,8 @@ export interface SendDataIntegrationEventRequest {
   eventType: DataIntegrationEventType | undefined;
 
   /**
-   * <p>The data payload of the event.</p>
+   * <p>The data payload of the event. For more information on the data schema to use, see <a href="https://docs.aws.amazon.com/aws-supply-chain/latest/userguide/data-model-asc.html">Data entities supported in AWS Supply Chain
+   *         </a>.</p>
    * @public
    */
   data: string | undefined;

diff --git a/codegen/sdk-codegen/aws-models/supplychain.json b/codegen/sdk-codegen/aws-models/supplychain.json
@@ -1299,7 +1299,7 @@
         }
       ],
       "traits": {
-        "smithy.api#documentation": "<p>Send transactional data events with real-time data for analysis or monitoring.</p>",
+        "smithy.api#documentation": "<p>Send the transactional data payload for the event with real-time data for analysis or monitoring. The real-time data events are stored in an Amazon Web Services service before being processed and stored in data lake. \n            New data events are synced with data lake at 5 PM GMT everyday. The updated transactional data is available in data lake after ingestion.</p>",
         "smithy.api#examples": [
           {
             "title": "Successful SendDataIntegrationEvent for inboundorder event type",
@@ -1526,7 +1526,7 @@
         "data": {
           "target": "com.amazonaws.supplychain#DataIntegrationEventData",
           "traits": {
-            "smithy.api#documentation": "<p>The data payload of the event.</p>",
+            "smithy.api#documentation": "<p>The data payload of the event. For more information on the data schema to use, see <a href=\"https://docs.aws.amazon.com/aws-supply-chain/latest/userguide/data-model-asc.html\">Data entities supported in AWS Supply Chain\n        </a>.</p>",
             "smithy.api#required": {}
           }
         },