From f7b618c1b1d34c9befbc60e2bcf4cd1fbb69ebcc Mon Sep 17 00:00:00 2001 From: awstools Date: Fri, 23 Aug 2024 18:25:49 +0000 Subject: [PATCH] docs(client-supplychain): Update API documentation to clarify the event SLA as well as the data model expectations --- .../src/commands/SendDataIntegrationEventCommand.ts | 3 ++- clients/client-supplychain/src/models/models_0.ts | 3 ++- codegen/sdk-codegen/aws-models/supplychain.json | 4 ++-- 3 files changed, 6 insertions(+), 4 deletions(-) diff --git a/clients/client-supplychain/src/commands/SendDataIntegrationEventCommand.ts b/clients/client-supplychain/src/commands/SendDataIntegrationEventCommand.ts index 9f8bc61b21c9a..54336bcda8bc9 100644 --- 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 {} /** - *

Send transactional data events with real-time data for analysis or monitoring.

+ *

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.

* @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 index 230ed9ffadc4a..a62bf7ed356d6 100644 --- 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; /** - *

The data payload of the event.

+ *

The data payload of the event. For more information on the data schema to use, see Data entities supported in AWS Supply Chain + * .

* @public */ data: string | undefined; diff --git a/codegen/sdk-codegen/aws-models/supplychain.json b/codegen/sdk-codegen/aws-models/supplychain.json index 2220dfbd5b446..9bf716bb93625 100644 --- a/codegen/sdk-codegen/aws-models/supplychain.json +++ b/codegen/sdk-codegen/aws-models/supplychain.json @@ -1299,7 +1299,7 @@ } ], "traits": { - "smithy.api#documentation": "

Send transactional data events with real-time data for analysis or monitoring.

", + "smithy.api#documentation": "

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.

", "smithy.api#examples": [ { "title": "Successful SendDataIntegrationEvent for inboundorder event type", @@ -1526,7 +1526,7 @@ "data": { "target": "com.amazonaws.supplychain#DataIntegrationEventData", "traits": { - "smithy.api#documentation": "

The data payload of the event.

", + "smithy.api#documentation": "

The data payload of the event. For more information on the data schema to use, see Data entities supported in AWS Supply Chain\n .

", "smithy.api#required": {} } },