Skip to content

Commit f7b618c

Browse files
author
awstools
committed
docs(client-supplychain): Update API documentation to clarify the event SLA as well as the data model expectations
1 parent ee762fe commit f7b618c

File tree

3 files changed

+6
-4
lines changed

3 files changed

+6
-4
lines changed

clients/client-supplychain/src/commands/SendDataIntegrationEventCommand.ts

Lines changed: 2 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -32,7 +32,8 @@ export interface SendDataIntegrationEventCommandInput extends SendDataIntegratio
3232
export interface SendDataIntegrationEventCommandOutput extends SendDataIntegrationEventResponse, __MetadataBearer {}
3333

3434
/**
35-
* <p>Send transactional data events with real-time data for analysis or monitoring.</p>
35+
* <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.
36+
* 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>
3637
* @example
3738
* Use a bare-bones client and the command you need to make an API call.
3839
* ```javascript

clients/client-supplychain/src/models/models_0.ts

Lines changed: 2 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -311,7 +311,8 @@ export interface SendDataIntegrationEventRequest {
311311
eventType: DataIntegrationEventType | undefined;
312312

313313
/**
314-
* <p>The data payload of the event.</p>
314+
* <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
315+
* </a>.</p>
315316
* @public
316317
*/
317318
data: string | undefined;

codegen/sdk-codegen/aws-models/supplychain.json

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -1299,7 +1299,7 @@
12991299
}
13001300
],
13011301
"traits": {
1302-
"smithy.api#documentation": "<p>Send transactional data events with real-time data for analysis or monitoring.</p>",
1302+
"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>",
13031303
"smithy.api#examples": [
13041304
{
13051305
"title": "Successful SendDataIntegrationEvent for inboundorder event type",
@@ -1526,7 +1526,7 @@
15261526
"data": {
15271527
"target": "com.amazonaws.supplychain#DataIntegrationEventData",
15281528
"traits": {
1529-
"smithy.api#documentation": "<p>The data payload of the event.</p>",
1529+
"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>",
15301530
"smithy.api#required": {}
15311531
}
15321532
},

0 commit comments

Comments
 (0)