Amazon Supply Chain Data Integration Events API

openapi: 3.1.0
info:
  title: AWS Supply Chain Data Integration Events API
  version: '2024-01-01'
  description: Generated from AWS's published Smithy model for AWS Supply Chain. 3 operation(s).
  contact:
    name: Amazon Web Services
    url: https://aws.amazon.com/contact-us/
  license:
    name: Apache 2.0
    identifier: Apache-2.0
    url: https://github.com/aws/api-models-aws/blob/main/LICENSE
servers:
- url: https://scn.{region}.amazonaws.com
  variables:
    region:
      default: us-east-1
security:
- sigv4: []
paths:
  /api-data/data-integration/instance/{instanceId}/data-integration-events/{eventId}:
    get:
      operationId: GetDataIntegrationEvent
      summary: Get Data Integration Event
      description: Enables you to programmatically view an Amazon Web Services Supply Chain Data Integration Event. Developers
        can view the eventType, eventGroupId, eventTimestamp, datasetTarget, datasetLoadExecution.
      responses:
        '200':
          description: Success
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/GetDataIntegrationEventResponse'
              example:
                event:
                  instanceId: 8928ae12-15e5-4441-825d-ec2184f0a43a
                  eventId: 19739c8e-cd2e-4cbc-a2f7-0dc43239f042
                  eventType: scn.data.dataset
                  eventGroupId: datasetId
                  eventTimestamp: 1515531081.123
                  datasetTargetDetails:
                    datasetIdentifier: arn:aws:scn:us-west-2:135808960812:instance/8928ae12-15e5-4441-825d-ec2184f0a43a/namespaces/asc/datasets/product
                    operationType: APPEND
                    datasetLoadExecution:
                      status: SUCCEEDED
        '403':
          description: AccessDeniedException; AccessDeniedException
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/AccessDeniedException'
        '500':
          description: InternalServerException; InternalServerException
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/InternalServerException'
        '404':
          description: ResourceNotFoundException; ResourceNotFoundException
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ResourceNotFoundException'
        '429':
          description: ThrottlingException; ThrottlingException
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ThrottlingException'
        '400':
          description: ValidationException; ValidationException
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ValidationException'
        '409':
          description: ConflictException
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ConflictException'
        '402':
          description: ServiceQuotaExceededException
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ServiceQuotaExceededException'
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/GetDataIntegrationEventRequest'
            example:
              instanceId: 8928ae12-15e5-4441-825d-ec2184f0a43a
              eventId: 19739c8e-cd2e-4cbc-a2f7-0dc43239f042
      tags:
      - Data Integration Events
  /api-data/data-integration/instance/{instanceId}/data-integration-events:
    get:
      operationId: ListDataIntegrationEvents
      summary: List Data Integration Events
      description: Enables you to programmatically list all data integration events for the provided Amazon Web Services Supply
        Chain instance.
      responses:
        '200':
          description: Success
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ListDataIntegrationEventsResponse'
              example:
                events:
                - instanceId: 8928ae12-15e5-4441-825d-ec2184f0a43a
                  eventId: 19739c8e-cd2e-4cbc-a2f7-0dc43239f042
                  eventType: scn.data.dataset
                  eventGroupId: datasetId
                  eventTimestamp: 1515531081.123
                  datasetTargetDetails:
                    datasetIdentifier: arn:aws:scn:us-west-2:135808960812:instance/8928ae12-15e5-4441-825d-ec2184f0a43a/namespaces/asc/datasets/product
                    operationType: APPEND
                    datasetLoadExecution:
                      status: SUCCEEDED
        '403':
          description: AccessDeniedException; AccessDeniedException
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/AccessDeniedException'
        '500':
          description: InternalServerException; InternalServerException
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/InternalServerException'
        '429':
          description: ThrottlingException; ThrottlingException
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ThrottlingException'
        '400':
          description: ValidationException; ValidationException
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ValidationException'
        '409':
          description: ConflictException
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ConflictException'
        '404':
          description: ResourceNotFoundException
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ResourceNotFoundException'
        '402':
          description: ServiceQuotaExceededException
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ServiceQuotaExceededException'
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/ListDataIntegrationEventsRequest'
            example:
              instanceId: 8928ae12-15e5-4441-825d-ec2184f0a43a
      tags:
      - Data Integration Events
    post:
      operationId: SendDataIntegrationEvent
      summary: Send Data Integration Event
      description: 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.
      responses:
        '200':
          description: Success
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/SendDataIntegrationEventResponse'
              example:
                eventId: c4132c1d-8f60-44a2-9932-f723c4f7b8a7
        '403':
          description: AccessDeniedException; AccessDeniedException
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/AccessDeniedException'
        '409':
          description: ConflictException; ConflictException
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ConflictException'
        '500':
          description: InternalServerException; InternalServerException
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/InternalServerException'
        '404':
          description: ResourceNotFoundException; ResourceNotFoundException
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ResourceNotFoundException'
        '402':
          description: ServiceQuotaExceededException; ServiceQuotaExceededException
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ServiceQuotaExceededException'
        '429':
          description: ThrottlingException; ThrottlingException
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ThrottlingException'
        '400':
          description: ValidationException; ValidationException
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ValidationException'
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/SendDataIntegrationEventRequest'
            example:
              instanceId: 8928ae12-15e5-4441-825d-ec2184f0a43a
              eventType: scn.data.inboundorder
              data: '{"id": "inbound-order-id-test-123", "tpartner_id": "partner-id-test-123" }'
              eventGroupId: inboundOrderId
              eventTimestamp: 1515531081.123
      tags:
      - Data Integration Events
components:
  securitySchemes:
    sigv4:
      type: apiKey
      in: header
      name: Authorization
      description: AWS Signature Version 4. The Authorization header carries an AWS4-HMAC-SHA256 signature over the canonical
        request, with X-Amz-Date (and X-Amz-Security-Token for temporary credentials). Not a bearer token.
      x-aws-sigv4:
        signingName: scn
  schemas:
    AccessDeniedException:
      type: object
      properties:
        message:
          type: string
    ConflictException:
      type: object
      properties:
        message:
          type: string
    DataIntegrationEvent:
      type: object
      properties:
        instanceId:
          type: string
          description: The AWS Supply Chain instance identifier.
        eventId:
          type: string
          description: The unique event identifier.
        eventType:
          type: string
          enum:
          - 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
          description: The data event type.
        eventGroupId:
          type: string
          description: Event identifier (for example, orderId for InboundOrder) used for data sharding or partitioning.
        eventTimestamp:
          type: string
          description: The event timestamp (in epoch seconds).
        datasetTargetDetails:
          $ref: '#/components/schemas/DataIntegrationEventDatasetTargetDetails'
      required:
      - instanceId
      - eventId
      - eventType
      - eventGroupId
      - eventTimestamp
    DataIntegrationEventDatasetLoadExecutionDetails:
      type: object
      properties:
        status:
          type: string
          enum:
          - SUCCEEDED
          - IN_PROGRESS
          - FAILED
          description: The event load execution status to target dataset.
        message:
          type: string
          description: The failure message (if any) of failed event load execution to dataset.
      required:
      - status
    DataIntegrationEventDatasetTargetConfiguration:
      type: object
      properties:
        datasetIdentifier:
          type: string
          description: The datalake dataset ARN identifier.
        operationType:
          type: string
          enum:
          - APPEND
          - UPSERT
          - DELETE
          description: The target dataset load operation type.
      required:
      - datasetIdentifier
      - operationType
    DataIntegrationEventDatasetTargetDetails:
      type: object
      properties:
        datasetIdentifier:
          type: string
          description: The datalake dataset ARN identifier.
        operationType:
          type: string
          enum:
          - APPEND
          - UPSERT
          - DELETE
          description: 'The target dataset load operation type. The available options are: APPEND - Add new records to the
            dataset. Noted that this operation type will just try to append records as-is without any primary key or partition
            constraints. UPSERT - Modify existing records in the dataset with primary key configured, events for datasets
            without primary keys are not allowed. If event data contains primary keys that match records in the dataset within
            same partition, then those existing records (in that partition) will be updated. If primary keys do not match,
            new records will be added. Note that if dataset co'
        datasetLoadExecution:
          $ref: '#/components/schemas/DataIntegrationEventDatasetLoadExecutionDetails'
      required:
      - datasetIdentifier
      - operationType
      - datasetLoadExecution
    GetDataIntegrationEventRequest:
      type: object
      properties:
        instanceId:
          type: string
          description: The Amazon Web Services Supply Chain instance identifier.
        eventId:
          type: string
          description: The unique event identifier.
      required:
      - instanceId
      - eventId
    GetDataIntegrationEventResponse:
      type: object
      properties:
        event:
          $ref: '#/components/schemas/DataIntegrationEvent'
      required:
      - event
    InternalServerException:
      type: object
      properties:
        message:
          type: string
    ListDataIntegrationEventsRequest:
      type: object
      properties:
        instanceId:
          type: string
          description: The Amazon Web Services Supply Chain instance identifier.
        eventType:
          type: string
          enum:
          - 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
          description: List data integration events for the specified eventType.
        nextToken:
          type: string
          description: The pagination token to fetch the next page of the data integration events.
        maxResults:
          type: integer
          description: Specify the maximum number of data integration events to fetch in one paginated request.
      required:
      - instanceId
    ListDataIntegrationEventsResponse:
      type: object
      properties:
        events:
          type: array
          items:
            $ref: '#/components/schemas/DataIntegrationEvent'
          description: The list of data integration events.
        nextToken:
          type: string
          description: The pagination token to fetch the next page of the ListDataIntegrationEvents.
      required:
      - events
    ResourceNotFoundException:
      type: object
      properties:
        message:
          type: string
    SendDataIntegrationEventRequest:
      type: object
      properties:
        instanceId:
          type: string
          description: The AWS Supply Chain instance identifier.
        eventType:
          type: string
          enum:
          - 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
          description: The data event type. scn.data.dataset - Send data directly to any specified dataset. scn.data.supplyplan
            - Send data to supply_plan dataset. scn.data.shipmentstoporder - Send data to shipment_stop_order dataset. scn.data.shipmentstop
            - Send data to shipment_stop dataset. scn.data.shipment - Send data to shipment dataset. scn.data.reservation
            - Send data to reservation dataset. scn.data.processproduct - Send data to process_product dataset. scn.data.processoperation
            - Send data to process_operation dataset. scn.data.processheader - Send data to process_header dataset. scn.data.forecast
            - Send d
        data:
          type: string
          description: 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:
          type: string
          description: 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:
          type: string
          description: The timestamp (in epoch seconds) associated with the event. If not provided, it will be assigned with
            current timestamp.
        clientToken:
          type: string
          description: 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.
        datasetTarget:
          $ref: '#/components/schemas/DataIntegrationEventDatasetTargetConfiguration'
      required:
      - instanceId
      - eventType
      - data
      - eventGroupId
    SendDataIntegrationEventResponse:
      type: object
      properties:
        eventId:
          type: string
          description: The unique event identifier.
      required:
      - eventId
    ServiceQuotaExceededException:
      type: object
      properties:
        message:
          type: string
    ThrottlingException:
      type: object
      properties:
        message:
          type: string
    ValidationException:
      type: object
      properties:
        message:
          type: string
x-provenance:
  method: harvested
  publisher: Amazon Web Services
  source: https://raw.githubusercontent.com/aws/api-models-aws/582e55931c45b944739742a2c1620b6026dd2d13/models/supplychain/service/2024-01-01/supplychain-2024-01-01.json
  note: converted by smithy-to-openapi.py from AWS's Smithy model (roadmap#1001)