Amazon Web Services, Inc.

AWS Supply Chain

AWS Supply Chain is a cloud-based application that works with your enterprise resource planning (ERP) and supply chain management systems. Using AWS Supply…

Logistics & shipping#openapi

Fork copies the collection into your workspace, without the publisher's secrets, so you can add your own key and send requests. Star saves it to your starred APIs (Account › Marketplace) and helps others find it.

Overview

AWS Supply Chain is a cloud-based application that works with your enterprise resource planning (ERP) and supply chain management systems. Using AWS Supply Chain, you can connect and extract your inventory, supply, and demand related data from existing ERP or supply chain systems into a single data model.

The AWS Supply Chain API supports configuration data import for Supply Planning.

All AWS Supply chain API operations are Amazon-authenticated and certificate-signed. They not only require the use of the AWS SDK, but also allow for the exclusive use of AWS Identity and Access Management users and roles to help facilitate access, trust, and permission policies.

Endpoints 30

Bill of materials import job

  • POSTCreate bill of materials import job/api/configuration/instances/:instanceId/bill-of-materials-import-jobsCreateBillOfMaterialsImportJob creates an import job for the Product Bill Of Materials (BOM) entity. For information on the product_bom entity, see the AWS…
  • GETGet bill of materials import job/api/configuration/instances/:instanceId/bill-of-materials-import-jobs/:jobIdGet status and details of a BillOfMaterialsImportJob.

Data integration flow

  • GETGet data integration flow/api/data-integration/instance/:instanceId/data-integration-flows/:nameEnables you to programmatically view a specific data pipeline for the provided Amazon Web Services Supply Chain instance and DataIntegrationFlow name.
  • PUTCreate data integration flow/api/data-integration/instance/:instanceId/data-integration-flows/:nameEnables you to programmatically create a data pipeline to ingest data from source systems such as Amazon S3 buckets, to a predefined Amazon Web Services…
  • DELETEDelete data integration flow/api/data-integration/instance/:instanceId/data-integration-flows/:nameEnable you to programmatically delete an existing data pipeline for the provided Amazon Web Services Supply Chain instance and DataIntegrationFlow name.
  • PATCHUpdate data integration flow/api/data-integration/instance/:instanceId/data-integration-flows/:nameEnables you to programmatically update an existing data pipeline to ingest data from the source systems such as, Amazon S3 buckets, to a predefined Amazon Web…
  • GETList data integration flows/api/data-integration/instance/:instanceId/data-integration-flows?nextToken=string&maxResults=0Enables you to programmatically list all data pipelines for the provided Amazon Web Services Supply Chain instance.

Data lake dataset

  • GETGet data lake dataset/api/datalake/instance/:instanceId/namespaces/:namespace/datasets/:nameEnables you to programmatically view an Amazon Web Services Supply Chain data lake dataset. Developers can view the data lake dataset information such as…
  • PUTCreate data lake dataset/api/datalake/instance/:instanceId/namespaces/:namespace/datasets/:nameEnables you to programmatically create an Amazon Web Services Supply Chain data lake dataset. Developers can create the datasets using their pre-defined or…
  • DELETEDelete data lake dataset/api/datalake/instance/:instanceId/namespaces/:namespace/datasets/:nameEnables you to programmatically delete an Amazon Web Services Supply Chain data lake dataset. Developers can delete the existing datasets for a given instance…
  • PATCHUpdate data lake dataset/api/datalake/instance/:instanceId/namespaces/:namespace/datasets/:nameEnables you to programmatically update an Amazon Web Services Supply Chain data lake dataset. Developers can update the description of a data lake dataset for…
  • GETList data lake datasets/api/datalake/instance/:instanceId/namespaces/:namespace/datasets?nextToken=string&maxResults=0Enables you to programmatically view the list of Amazon Web Services Supply Chain data lake datasets. Developers can view the datasets and the corresponding…

Data lake namespace

  • GETGet data lake namespace/api/datalake/instance/:instanceId/namespaces/:nameEnables you to programmatically view an Amazon Web Services Supply Chain data lake namespace. Developers can view the data lake namespace information such as…
  • PUTCreate data lake namespace/api/datalake/instance/:instanceId/namespaces/:nameEnables you to programmatically create an Amazon Web Services Supply Chain data lake namespace. Developers can create the namespaces for a given instance ID.
  • DELETEDelete data lake namespace/api/datalake/instance/:instanceId/namespaces/:nameEnables you to programmatically delete an Amazon Web Services Supply Chain data lake namespace and its underling datasets. Developers can delete the existing…
  • PATCHUpdate data lake namespace/api/datalake/instance/:instanceId/namespaces/:nameEnables you to programmatically update an Amazon Web Services Supply Chain data lake namespace. Developers can update the description of a data lake namespace…
  • GETList data lake namespaces/api/datalake/instance/:instanceId/namespaces?nextToken=string&maxResults=0Enables you to programmatically view the list of Amazon Web Services Supply Chain data lake namespaces. Developers can view the namespaces and the…

Instance

  • GETList instances/api/instance?nextToken=string&maxResults=0&instanceNameFilter=&instanceStateFilter=List all Amazon Web Services Supply Chain instances for a specific account. Enables you to programmatically list all Amazon Web Services Supply Chain…
  • POSTCreate instance/api/instanceEnables you to programmatically create an Amazon Web Services Supply Chain instance by applying KMS keys and relevant information associated with the API…
  • GETGet instance/api/instance/:instanceIdEnables you to programmatically retrieve the information related to an Amazon Web Services Supply Chain instance ID.
  • DELETEDelete instance/api/instance/:instanceIdEnables you to programmatically delete an Amazon Web Services Supply Chain instance by deleting the KMS keys and relevant information associated with the API…
  • PATCHUpdate instance/api/instance/:instanceIdEnables you to programmatically update an Amazon Web Services Supply Chain instance description by providing all the relevant information such as account ID,…
  • GETGet data integration event/api-data/data-integration/instance/:instanceId/data-integration-events/:eventIdEnables you to programmatically view an Amazon Web Services Supply Chain Data Integration Event. Developers can view the eventType, eventGroupId,…
  • GETGet data integration flow execution/api-data/data-integration/instance/:instanceId/data-integration-flows/:flowName/executions/:executionIdGet the flow execution.
  • GETList data integration events/api-data/data-integration/instance/:instanceId/data-integration-events?eventType=string&nextToken=string&maxResults=0Enables you to programmatically list all data integration events for the provided Amazon Web Services Supply Chain instance.
  • POSTSend data integration event/api-data/data-integration/instance/:instanceId/data-integration-eventsSend 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…
  • GETList data integration flow executions/api-data/data-integration/instance/:instanceId/data-integration-flows/:flowName/executions?nextToken=string&maxResults=0List flow executions.
  • GETList tags for resource/api/tags/:resourceArnList all the tags for an Amazon Web ServicesSupply Chain resource. You can list all the tags added to a resource. By listing the tags, developers can view the…
  • POSTTag resource/api/tags/:resourceArnYou can create tags during or after creating a resource such as instance, data flow, or dataset in AWS Supply chain. During the data ingestion process, you…
  • DELETEUntag resource/api/tags/:resourceArn?tagKeys=You can delete tags for an Amazon Web Services Supply chain resource such as instance, data flow, or dataset in AWS Supply Chain. During the data ingestion…

API details

Base URL
https://scn.{region}.amazonaws.com
Authentication
AWS Signature Version 4 (requests signed with your AWS access key)
Operations
30 operations on 15 pathsGET 14DELETE 5POST 4PATCH 4PUT 3
Main resources
Data integration flow 5Data lake dataset 5Data lake namespace 5Instance 5Bill of materials import job 2
Description format
AWS Smithy model, API version 2024-01-01

How to test the AWS Supply Chain in Swastik Codes

  1. Open the APISelect “Fork & run in Swastik Codes” on this page. Sign in or create a free account if asked.
  2. Fork it into your workspaceChoose a workspace. You get your own copy of the AWS Supply Chain collection, without the publisher's secrets.
  3. Add your credentialsThis API uses AWS Signature Version 4 (requests signed with your AWS access key). Add yours in the collection's variables or an environment; the requests already reference it.
  4. Send a requestPick an endpoint, for example “Create bill of materials import job” (POST /api/configuration/instances/:instanceId/bill-of-materials-import-jobs), and press Send. Check the response, add tests and run the whole collection with the runner.

Frequently asked questions

What is the AWS Supply Chain?

AWS Supply Chain is a cloud-based application that works with your enterprise resource planning (ERP) and supply chain management systems. Using AWS Supply… It is listed under Logistics & shipping and has 30 endpoints.

Who publishes the AWS Supply Chain?

It is listed from Amazon Web Services, Inc.'s public API description (an OpenAPI document), not published by Amazon Web Services, Inc. on Swastik Codes. Anyone who controls amazonaws.com can claim the profile by adding a DNS TXT record.

What is the base URL of the AWS Supply Chain?

Requests go to https://scn.{region}.amazonaws.com. Endpoint paths are added to this base URL.

How do I authenticate with the AWS Supply Chain?

With AWS Signature Version 4 (requests signed with your AWS access key).

How many endpoints does the AWS Supply Chain have?

30 operations on 15 paths (14 GET, 5 DELETE, 4 POST, 4 PATCH, 3 PUT). The largest groups are Data integration flow, Data lake dataset, Data lake namespace, Instance.

Is forking the AWS Supply Chain free?

Yes. Forking copies the collection into your workspace for free. It has been starred 0 times and forked 0 times.

Suggest an API

Tell us which public API is missing. We check it, then add it here with its endpoints when it has an OpenAPI (Swagger) description.