Amazon Supply Chain

Amazon Supply Chain Instances API

The Instances API from Amazon Supply Chain — 2 operation(s) for instances.

Documentation GitHub OpenAPI

Operations 5

POST /api/instance Create Instance #

GET /api/instance List Instances #

GET /api/instance/{instanceId} Get Instance #

PATCH /api/instance/{instanceId} Update Instance #

DELETE /api/instance/{instanceId} Delete Instance #

Work with this as data

Every API here is available over the APIs.io API and to AI agents over MCP.

MCP server

One button, every client — Claude, Cursor, VS Code and the rest.

https://apis.io/mcp

Tools for apis

7 MCP tools reach this

find_apisBrowse and filter every API in the catalog.
get_api_artifactsOne API's artifacts, grouped by type.
get_openapiThe primary OpenAPI for this API.
find_similar_apisAPIs that look like this one.
apis_io_searchSTART HERE — APIs, providers and tags for one query, each with its total.
resolveTurn a domain, URL or GitHub org into the provider it belongs to.
find_cohortsEvery scored population of providers in the catalog.

All 92 tools →

Call it yourself

curl for this page

This API

curl "https://apis.io/api/v1/apis/amazon-supply-chain:amazon-supply-chain-instances-api"

All apis

curl "https://apis.io/api/v1/apis?limit=25"

Calls without X-API-Key need no key. Calls with it need a paid plan — get a key.

Get an API key

Free tier, no form to fill in. Signing in shares your email address with us — we store it to create your key and to recognise you if you sign in with another provider. See our Privacy Policy and Terms.

GitHub Google LinkedIn

A second provider on the same verified email joins the account you already have.

OpenAPI Specification

openapi: 3.1.0
info:
  title: AWS Supply Chain Instances API
  version: '2024-01-01'
  description: Generated from AWS's published Smithy model for AWS Supply Chain. 5 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/instance:
    post:
      operationId: CreateInstance
      summary: Create Instance
      description: Enables you to programmatically create an Amazon Web Services Supply Chain instance by applying KMS keys
        and relevant information associated with the API without using the Amazon Web Services console. This is an asynchronous
        operation. Upon receiving a CreateInstance request, Amazon Web Services Supply Chain immediately returns the instance
        resource, instance ID, and the initializing state while simultaneously creating all required Amazon Web Services resources
        for an instance creation. You can use GetInstance to check the status of the instance. If the instance results in
        an unhealthy state, you need to check the error message, delete the current instance, and recreate a new one based
        on the mitigation from the error message.
      responses:
        '200':
          description: Success
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/CreateInstanceResponse'
              example:
                instance:
                  instanceId: 9e193580-7cc5-45f7-9609-c43ba0ada793
                  awsAccountId: '123456789012'
                  state: Initializing
                  createdTime: 172615383136
                  lastModifiedTime: 172615383136
                  instanceName: example instance name
                  instanceDescription: example instance description
                  kmsKeyArn: arn:aws:kms:us-west-2:123456789012:key/b14ffc39-b7d4-45ab-991a-6257a7f0d24d
                  versionNumber: 2.0
        '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'
        '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'
        '404':
          description: ResourceNotFoundException
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ResourceNotFoundException'
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/CreateInstanceRequest'
            example:
              instanceName: example instance name
              instanceDescription: example instance description
              kmsKeyArn: arn:aws:kms:us-west-2:123456789012:key/b14ffc39-b7d4-45ab-991a-6257a7f0d24d
              tags:
                tagKey1: tagValue1
      tags:
      - Instances
    get:
      operationId: ListInstances
      summary: List Instances
      description: List all Amazon Web Services Supply Chain instances for a specific account. Enables you to programmatically
        list all Amazon Web Services Supply Chain instances based on their account ID, instance name, and state of the instance
        (active or delete).
      responses:
        '200':
          description: Success
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ListInstancesResponse'
              example:
                instances:
                - instanceId: 9e193580-7cc5-45f7-9609-c43ba0ada793
                  awsAccountId: '123456789012'
                  state: Active
                  createdTime: 172615383136
                  lastModifiedTime: 172615383136
                  instanceName: example instance name
                  instanceDescription: example instance description
                  kmsKeyArn: arn:aws:kms:us-west-2:123456789012:key/b14ffc39-b7d4-45ab-991a-6257a7f0d24d
                  versionNumber: 2.0
                - instanceId: 3ad8116a-644d-4172-8dcb-20e51d314c14
                  awsAccountId: '123456789012'
                  state: Initializing
                  createdTime: 17261674383136
                  lastModifiedTime: 17261674383136
                  instanceDescription: example instance description
                  kmsKeyArn: arn:aws:kms:us-west-2:123456789012:key/b14ffc39-b7d4-45ab-991a-6257a7f0d24d
                  versionNumber: 2.0
        '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/ListInstancesRequest'
      tags:
      - Instances
  /api/instance/{instanceId}:
    get:
      operationId: GetInstance
      summary: Get Instance
      description: Enables you to programmatically retrieve the information related to an Amazon Web Services Supply Chain
        instance ID.
      responses:
        '200':
          description: Success
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/GetInstanceResponse'
              example:
                instance:
                  instanceId: 9e193580-7cc5-45f7-9609-c43ba0ada793
                  awsAccountId: '123456789012'
                  state: Active
                  createdTime: 172615383136
                  lastModifiedTime: 172615383136
                  instanceName: example instance name
                  instanceDescription: example instance description
                  kmsKeyArn: arn:aws:kms:us-west-2:123456789012:key/b14ffc39-b7d4-45ab-991a-6257a7f0d24d
                  versionNumber: 2.0
        '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/GetInstanceRequest'
            example:
              instanceId: 9e193580-7cc5-45f7-9609-c43ba0ada793
      tags:
      - Instances
    patch:
      operationId: UpdateInstance
      summary: Update Instance
      description: Enables you to programmatically update an Amazon Web Services Supply Chain instance description by providing
        all the relevant information such as account ID, instance ID and so on without using the AWS console.
      responses:
        '200':
          description: Success
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/UpdateInstanceResponse'
              example:
                instance:
                  instanceId: 9e193580-7cc5-45f7-9609-c43ba0ada793
                  awsAccountId: '123456789012'
                  state: Active
                  createdTime: 172615383136
                  lastModifiedTime: 172615383136
                  instanceName: updated example instance name
                  instanceDescription: updated example instance description
                  kmsKeyArn: arn:aws:kms:us-west-2:123456789012:key/b14ffc39-b7d4-45ab-991a-6257a7f0d24d
                  versionNumber: 2.0
        '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/UpdateInstanceRequest'
            example:
              instanceId: 9e193580-7cc5-45f7-9609-c43ba0ada793
              instanceName: updated example instance name
              instanceDescription: updated example instance description
      tags:
      - Instances
    delete:
      operationId: DeleteInstance
      summary: Delete Instance
      description: Enables you to programmatically delete an Amazon Web Services Supply Chain instance by deleting the KMS
        keys and relevant information associated with the API without using the Amazon Web Services console. This is an asynchronous
        operation. Upon receiving a DeleteInstance request, Amazon Web Services Supply Chain immediately returns a response
        with the instance resource, delete state while cleaning up all Amazon Web Services resources created during the instance
        creation process. You can use the GetInstance action to check the instance status.
      responses:
        '200':
          description: Success
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/DeleteInstanceResponse'
              example:
                instance:
                  instanceId: 9e193580-7cc5-45f7-9609-c43ba0ada793
                  awsAccountId: '123456789012'
                  state: Deleting
                  createdTime: 172615383136
                  lastModifiedTime: 172615383136
                  instanceName: updated example instance name
                  instanceDescription: updated example instance description
                  kmsKeyArn: arn:aws:kms:us-west-2:123456789012:key/b14ffc39-b7d4-45ab-991a-6257a7f0d24d
                  versionNumber: 2.0
        '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/DeleteInstanceRequest'
            example:
              instanceId: 9e193580-7cc5-45f7-9609-c43ba0ada793
      tags:
      - Instances
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
    CreateInstanceRequest:
      type: object
      properties:
        instanceName:
          type: string
          description: The AWS Supply Chain instance name.
        instanceDescription:
          type: string
          description: The AWS Supply Chain instance description.
        kmsKeyArn:
          type: string
          description: The ARN (Amazon Resource Name) of the Key Management Service (KMS) key you provide for encryption.
            This is required if you do not want to use the Amazon Web Services owned KMS key. If you don't provide anything
            here, AWS Supply Chain uses the Amazon Web Services owned KMS key.
        webAppDnsDomain:
          type: string
          description: The DNS subdomain of the web app. This would be "example" in the URL "example.scn.global.on.aws". You
            can set this to a custom value, as long as the domain isn't already being used by someone else. The name may only
            include alphanumeric characters and hyphens.
        tags:
          type: object
          additionalProperties:
            type: string
          description: The Amazon Web Services tags of an instance to be created.
        clientToken:
          type: string
          description: The client token for idempotency.
    CreateInstanceResponse:
      type: object
      properties:
        instance:
          $ref: '#/components/schemas/Instance'
      required:
      - instance
    DeleteInstanceRequest:
      type: object
      properties:
        instanceId:
          type: string
          description: The AWS Supply Chain instance identifier.
      required:
      - instanceId
    DeleteInstanceResponse:
      type: object
      properties:
        instance:
          $ref: '#/components/schemas/Instance'
      required:
      - instance
    GetInstanceRequest:
      type: object
      properties:
        instanceId:
          type: string
          description: The AWS Supply Chain instance identifier
      required:
      - instanceId
    GetInstanceResponse:
      type: object
      properties:
        instance:
          $ref: '#/components/schemas/Instance'
      required:
      - instance
    Instance:
      type: object
      properties:
        instanceId:
          type: string
          description: The Amazon Web Services Supply Chain instance identifier.
        awsAccountId:
          type: string
          description: The Amazon Web Services account ID that owns the instance.
        state:
          type: string
          enum:
          - Initializing
          - Active
          - CreateFailed
          - DeleteFailed
          - Deleting
          - Deleted
          description: The state of the instance.
        errorMessage:
          type: string
          description: The Amazon Web Services Supply Chain instance error message. If the instance results in an unhealthy
            state, customers need to check the error message, delete the current instance, and recreate a new one based on
            the mitigation from the error message.
        webAppDnsDomain:
          type: string
          description: The WebApp DNS domain name of the instance.
        createdTime:
          type: string
          description: The instance creation timestamp.
        lastModifiedTime:
          type: string
          description: The instance last modified timestamp.
        instanceName:
          type: string
          description: The Amazon Web Services Supply Chain instance name.
        instanceDescription:
          type: string
          description: The Amazon Web Services Supply Chain instance description.
        kmsKeyArn:
          type: string
          description: The ARN (Amazon Resource Name) of the Key Management Service (KMS) key you optionally provided for
            encryption. If you did not provide anything here, AWS Supply Chain uses the Amazon Web Services owned KMS key
            and nothing is returned.
        versionNumber:
          type: number
          description: The version number of the instance.
      required:
      - instanceId
      - awsAccountId
      - state
    InternalServerException:
      type: object
      properties:
        message:
          type: string
    ListInstancesRequest:
      type: object
      properties:
        nextToken:
          type: string
          description: The pagination token to fetch the next page of instances.
        maxResults:
          type: integer
          description: Specify the maximum number of instances to fetch in this paginated request.
        instanceNameFilter:
          type: array
          items:
            type: string
          description: The filter to ListInstances based on their names.
        instanceStateFilter:
          type: array
          items:
            type: string
            enum:
            - Initializing
            - Active
            - CreateFailed
            - DeleteFailed
            - Deleting
            - Deleted
          description: The filter to ListInstances based on their state.
    ListInstancesResponse:
      type: object
      properties:
        instances:
          type: array
          items:
            $ref: '#/components/schemas/Instance'
          description: The list of instances resource data details.
        nextToken:
          type: string
          description: The pagination token to fetch the next page of instances.
      required:
      - instances
    ResourceNotFoundException:
      type: object
      properties:
        message:
          type: string
    ServiceQuotaExceededException:
      type: object
      properties:
        message:
          type: string
    ThrottlingException:
      type: object
      properties:
        message:
          type: string
    UpdateInstanceRequest:
      type: object
      properties:
        instanceId:
          type: string
          description: The AWS Supply Chain instance identifier.
        instanceName:
          type: string
          description: The AWS Supply Chain instance name.
        instanceDescription:
          type: string
          description: The AWS Supply Chain instance description.
      required:
      - instanceId
    UpdateInstanceResponse:
      type: object
      properties:
        instance:
          $ref: '#/components/schemas/Instance'
      required:
      - instance
    ValidationException:
      type: object
      properties:
        message:
          type: string
x-provenance:
  method: harvested
  publisher: Amazon Web Services
  source: https://raw.githubusercontent.com/aws/api-models-aws/3cd98287b471c106254abd89279cc87308d38bfd/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)