SupplyChain / Client / send_data_integration_event

send_data_integration_event

SupplyChain.Client.send_data_integration_event(**kwargs)

Send the 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.

See also: AWS API Documentation

Request Syntax

response = client.send_data_integration_event(
    instanceId='string',
    eventType='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'|'scn.data.dataset',
    data='string',
    eventGroupId='string',
    eventTimestamp=datetime(2015, 1, 1),
    clientToken='string',
    datasetTarget={
        'datasetIdentifier': 'string',
        'operationType': 'APPEND'|'UPSERT'|'DELETE'
    }
)
Parameters:

  • instanceId (string) –

    [REQUIRED]

    The AWS Supply Chain instance identifier.

  • eventType (string) –

    [REQUIRED]

    The data event type.

  • data (string) –

    [REQUIRED]

    The data payload of the event, should follow the data schema of the target dataset, or see Data entities supported in AWS Supply Chain. To send single data record, use JsonObject format; to send multiple data records, use JsonArray format.

    Note that for AWS Supply Chain dataset under asc namespace, it has a connection_id internal field that is not allowed to be provided by client directly, they will be auto populated.

  • eventGroupId (string) –

    [REQUIRED]

    Event identifier (for example, orderId for InboundOrder) used for data sharding or partitioning. Noted under one eventGroupId of same eventType and instanceId, events are processed sequentially in the order they are received by the server.

  • eventTimestamp (datetime) – The timestamp (in epoch seconds) associated with the event. If not provided, it will be assigned with current timestamp.

  • clientToken (string) –

    The idempotent client token. The token is active for 8 hours, and within its lifetime, it ensures the request completes only once upon retry with same client token. If omitted, the AWS SDK generates a unique value so that AWS SDK can safely retry the request upon network errors.

    This field is autopopulated if not provided.

  • datasetTarget (dict) –

    The target dataset configuration for scn.data.dataset event type.

    • datasetIdentifier (string) – [REQUIRED]

      The datalake dataset ARN identifier.

    • operationType (string) – [REQUIRED]

      The target dataset load operation type.

Return type:

dict

Returns:

Response Syntax

{
    'eventId': 'string'
}

Response Structure

  • (dict) –

    The response parameters for SendDataIntegrationEvent.

    • eventId (string) –

      The unique event identifier.

Exceptions