SendDataIntegrationEvent - AWS Supply Chain
Request SyntaxURI Request ParametersRequest BodyResponse SyntaxResponse ElementsErrorsSee Also

SendDataIntegrationEvent

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 AWS 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.

Request Syntax

POST /api-data/data-integration/instance/instanceId/data-integration-events HTTP/1.1
Content-type: application/json

{
   "clientToken": "string",
   "data": "string",
   "eventGroupId": "string",
   "eventTimestamp": number,
   "eventType": "string"
}

URI Request Parameters

The request uses the following URI parameters.

instanceId

The AWS Supply Chain instance identifier.

Length Constraints: Fixed length of 36.

Pattern: [a-f0-9]{8}-[a-f0-9]{4}-[a-f0-9]{4}-[a-f0-9]{4}-[a-f0-9]{12}

Required: Yes

Request Body

The request accepts the following data in JSON format.

clientToken

The idempotent client token.

Type: String

Length Constraints: Minimum length of 33. Maximum length of 126.

Required: No

data

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

Type: String

Length Constraints: Minimum length of 1. Maximum length of 1048576.

Required: Yes

eventGroupId

Event identifier (for example, orderId for InboundOrder) used for data sharing or partitioning.

Type: String

Length Constraints: Minimum length of 1. Maximum length of 255.

Required: Yes

eventTimestamp

The event timestamp (in epoch seconds).

Type: Timestamp

Required: No

eventType

The data event type.

Type: String

Valid Values: scn.data.forecast | scn.data.inventorylevel | scn.data.inboundorder | scn.data.inboundorderline | scn.data.inboundorderlineschedule | scn.data.outboundorderline | scn.data.outboundshipment | scn.data.processheader | scn.data.processoperation | scn.data.processproduct | scn.data.reservation | scn.data.shipment | scn.data.shipmentstop | scn.data.shipmentstoporder | scn.data.supplyplan

Required: Yes

Response Syntax

HTTP/1.1 200
Content-type: application/json

{
   "eventId": "string"
}

Response Elements

If the action is successful, the service sends back an HTTP 200 response.

The following data is returned in JSON format by the service.

eventId

The unique event identifier.

Type: String

Length Constraints: Fixed length of 36.

Pattern: [a-f0-9]{8}-[a-f0-9]{4}-[a-f0-9]{4}-[a-f0-9]{4}-[a-f0-9]{12}

Errors

For information about the errors that are common to all actions, see Common Errors.

AccessDeniedException

You do not have the required privileges to perform this action.

HTTP Status Code: 403

ConflictException

Updating or deleting a resource can cause an inconsistent state.

HTTP Status Code: 409

InternalServerException

Unexpected error during processing of request.

HTTP Status Code: 500

ResourceNotFoundException

Request references a resource which does not exist.

HTTP Status Code: 404

ServiceQuotaExceededException

Request would cause a service quota to be exceeded.

HTTP Status Code: 402

ThrottlingException

Request was denied due to request throttling.

HTTP Status Code: 429

ValidationException

The input does not satisfy the constraints specified by an AWS service.

HTTP Status Code: 400

See Also

For more information about using this API in one of the language-specific AWS SDKs, see the following: