Amazon IoT SiteWise

Amazon IoT SiteWise Iot Sitewise Asset Model Interface Relationship API

The Iot Sitewise Asset Model Interface Relationship API from Amazon IoT SiteWise — 1 operation(s) for iot sitewise asset model interface relationship.

GitHub OpenAPI

Operations 3

DELETE /asset-models/{assetModelId}/interface/{interfaceAssetModelId}/asset-model-interface-relationship Delete Asset Model Interface Relationship #
GET /asset-models/{assetModelId}/interface/{interfaceAssetModelId}/asset-model-interface-relationship Describe Asset Model Interface Relationship #
PUT /asset-models/{assetModelId}/interface/{interfaceAssetModelId}/asset-model-interface-relationship Put Asset Model Interface Relationship #

Specifications

⚙
OpenAPI
https://artifacts.apis.io/amazon-iot-sitewise/openapi/amazon-iot-sitewise-asset-model-interface-relationship-api-openapi.yml

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-iot-sitewise:amazon-iot-sitewise-asset-model-interface-relationship-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

amazon-iot-sitewise-asset-model-interface-relationship-api-openapi.yml Raw ↑ 
openapi: 3.2.0
info:
  title: AWS IoT SiteWise Asset Model Interface Relationship API
  version: '2019-12-02'
  description: Generated from AWS's published Smithy model for AWS IoT SiteWise. 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://iotsitewise.{region}.amazonaws.com
  variables:
    region:
      default: us-east-1
security:
- sigv4: []
tags:
- name: Asset Model Interface Relationship
paths:
  /asset-models/{assetModelId}/interface/{interfaceAssetModelId}/asset-model-interface-relationship:
    delete:
      operationId: DeleteAssetModelInterfaceRelationship
      summary: Delete Asset Model Interface Relationship
      description: Deletes an interface relationship between an asset model and an interface asset model.
      responses:
        '200':
          description: Success
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/DeleteAssetModelInterfaceRelationshipResponse'
        '409':
          description: ConflictingOperationException
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ConflictingOperationException'
        '500':
          description: InternalFailureException
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/InternalFailureException'
        '400':
          description: InvalidRequestException
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/InvalidRequestException'
        '404':
          description: ResourceNotFoundException
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ResourceNotFoundException'
        '429':
          description: ThrottlingException
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ThrottlingException'
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/DeleteAssetModelInterfaceRelationshipRequest'
      tags:
      - Asset Model Interface Relationship
    get:
      operationId: DescribeAssetModelInterfaceRelationship
      summary: Describe Asset Model Interface Relationship
      description: Retrieves information about an interface relationship between an asset model and an interface asset model.
      responses:
        '200':
          description: Success
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/DescribeAssetModelInterfaceRelationshipResponse'
        '500':
          description: InternalFailureException
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/InternalFailureException'
        '400':
          description: InvalidRequestException
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/InvalidRequestException'
        '404':
          description: ResourceNotFoundException
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ResourceNotFoundException'
        '429':
          description: ThrottlingException
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ThrottlingException'
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/DescribeAssetModelInterfaceRelationshipRequest'
      tags:
      - Asset Model Interface Relationship
    put:
      operationId: PutAssetModelInterfaceRelationship
      summary: Put Asset Model Interface Relationship
      description: Creates or updates an interface relationship between an asset model and an interface asset model. This operation applies an interface to an asset model.
      responses:
        '200':
          description: Success
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/PutAssetModelInterfaceRelationshipResponse'
        '409':
          description: ConflictingOperationException
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ConflictingOperationException'
        '500':
          description: InternalFailureException
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/InternalFailureException'
        '400':
          description: InvalidRequestException
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/InvalidRequestException'
        '410':
          description: LimitExceededException
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/LimitExceededException'
        '404':
          description: ResourceNotFoundException
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ResourceNotFoundException'
        '429':
          description: ThrottlingException
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ThrottlingException'
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/PutAssetModelInterfaceRelationshipRequest'
      tags:
      - Asset Model Interface Relationship
components:
  schemas:
    DescribeAssetModelInterfaceRelationshipRequest:
      type: object
      properties:
        assetModelId:
          type: string
          description: 'The ID of the asset model. This can be either the actual ID in UUID format, or else externalId: followed by the external ID.'
        interfaceAssetModelId:
          type: string
          description: 'The ID of the interface asset model. This can be either the actual ID in UUID format, or else externalId: followed by the external ID.'
      required:
      - assetModelId
      - interfaceAssetModelId
    PropertyMappingConfiguration:
      type: object
      properties:
        matchByPropertyName:
          type: boolean
          description: If true, properties are matched by name between the interface asset model and the asset model where the interface is applied.
        createMissingProperty:
          type: boolean
          description: If true, missing properties from the interface asset model are automatically created in the asset model where the interface is applied.
        overrides:
          type: array
          items:
            $ref: '#/components/schemas/PropertyMapping'
          description: A list of specific property mappings that override the automatic mapping by name when an interface is applied to an asset model.
    HierarchyMapping:
      type: object
      properties:
        assetModelHierarchyId:
          type: string
          description: The ID of the hierarchy in the asset model where the interface is applied.
        interfaceAssetModelHierarchyId:
          type: string
          description: The ID of the hierarchy in the interface asset model.
      required:
      - assetModelHierarchyId
      - interfaceAssetModelHierarchyId
    DetailedError:
      type: object
      properties:
        code:
          type: string
          enum:
          - INCOMPATIBLE_COMPUTE_LOCATION
          - INCOMPATIBLE_FORWARDING_CONFIGURATION
          description: The error code.
        message:
          type: string
          description: The error message.
      required:
      - code
      - message
    ErrorDetails:
      type: object
      properties:
        code:
          type: string
          enum:
          - VALIDATION_ERROR
          - INTERNAL_FAILURE
          description: The error code.
        message:
          type: string
          description: The error message.
        details:
          type: array
          items:
            $ref: '#/components/schemas/DetailedError'
          description: A list of detailed errors.
      required:
      - code
      - message
    PropertyMapping:
      type: object
      properties:
        assetModelPropertyId:
          type: string
          description: The ID of the property in the asset model where the interface is applied.
        interfaceAssetModelPropertyId:
          type: string
          description: The ID of the property in the interface asset model.
      required:
      - assetModelPropertyId
      - interfaceAssetModelPropertyId
    DeleteAssetModelInterfaceRelationshipRequest:
      type: object
      properties:
        assetModelId:
          type: string
          description: 'The ID of the asset model. This can be either the actual ID in UUID format, or else externalId: followed by the external ID.'
        interfaceAssetModelId:
          type: string
          description: 'The ID of the interface asset model. This can be either the actual ID in UUID format, or else externalId: followed by the external ID.'
        clientToken:
          type: string
          description: A unique case-sensitive identifier that you can provide to ensure the idempotency of the request. Don't reuse this client token if a new idempotent request is required.
      required:
      - assetModelId
      - interfaceAssetModelId
    AssetModelStatus:
      type: object
      properties:
        state:
          type: string
          enum:
          - CREATING
          - ACTIVE
          - UPDATING
          - PROPAGATING
          - DELETING
          - FAILED
          description: The current state of the asset model.
        error:
          $ref: '#/components/schemas/ErrorDetails'
      required:
      - state
    DescribeAssetModelInterfaceRelationshipResponse:
      type: object
      properties:
        assetModelId:
          type: string
          description: The ID of the asset model.
        interfaceAssetModelId:
          type: string
          description: The ID of the interface asset model.
        propertyMappings:
          type: array
          items:
            $ref: '#/components/schemas/PropertyMapping'
          description: A list of property mappings between the interface asset model and the asset model where the interface is applied.
        hierarchyMappings:
          type: array
          items:
            $ref: '#/components/schemas/HierarchyMapping'
          description: A list of hierarchy mappings between the interface asset model and the asset model where the interface is applied.
      required:
      - assetModelId
      - interfaceAssetModelId
      - propertyMappings
      - hierarchyMappings
    InvalidRequestException:
      type: object
      properties:
        message:
          type: string
      required:
      - message
    PutAssetModelInterfaceRelationshipRequest:
      type: object
      properties:
        assetModelId:
          type: string
          description: 'The ID of the asset model. This can be either the actual ID in UUID format, or else externalId: followed by the external ID.'
        interfaceAssetModelId:
          type: string
          description: 'The ID of the interface asset model. This can be either the actual ID in UUID format, or else externalId: followed by the external ID.'
        propertyMappingConfiguration:
          $ref: '#/components/schemas/PropertyMappingConfiguration'
        clientToken:
          type: string
          description: A unique case-sensitive identifier that you can provide to ensure the idempotency of the request. Don't reuse this client token if a new idempotent request is required.
      required:
      - assetModelId
      - interfaceAssetModelId
      - propertyMappingConfiguration
    PutAssetModelInterfaceRelationshipResponse:
      type: object
      properties:
        assetModelId:
          type: string
          description: The ID of the asset model.
        interfaceAssetModelId:
          type: string
          description: The ID of the interface asset model.
        assetModelArn:
          type: string
          description: The ARN of the asset model, which has the following format. arn:${Partition}:iotsitewise:${Region}:${Account}:asset-model/${AssetModelId}
        assetModelStatus:
          $ref: '#/components/schemas/AssetModelStatus'
      required:
      - assetModelId
      - interfaceAssetModelId
      - assetModelArn
      - assetModelStatus
    ThrottlingException:
      type: object
      properties:
        message:
          type: string
      required:
      - message
    ResourceNotFoundException:
      type: object
      properties:
        message:
          type: string
      required:
      - message
    InternalFailureException:
      type: object
      properties:
        message:
          type: string
      required:
      - message
    DeleteAssetModelInterfaceRelationshipResponse:
      type: object
      properties:
        assetModelId:
          type: string
          description: The ID of the asset model.
        interfaceAssetModelId:
          type: string
          description: The ID of the interface asset model.
        assetModelArn:
          type: string
          description: The ARN of the asset model, which has the following format. arn:${Partition}:iotsitewise:${Region}:${Account}:asset-model/${AssetModelId}
        assetModelStatus:
          $ref: '#/components/schemas/AssetModelStatus'
      required:
      - assetModelId
      - interfaceAssetModelId
      - assetModelArn
      - assetModelStatus
    LimitExceededException:
      type: object
      properties:
        message:
          type: string
      required:
      - message
    ConflictingOperationException:
      type: object
      properties:
        message:
          type: string
        resourceId:
          type: string
          description: The ID of the resource that conflicts with this operation.
        resourceArn:
          type: string
          description: The ARN of the resource that conflicts with this operation.
      required:
      - message
      - resourceId
      - resourceArn
  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: iotsitewise
x-provenance:
  method: harvested
  publisher: Amazon Web Services
  source: https://raw.githubusercontent.com/aws/api-models-aws/582e55931c45b944739742a2c1620b6026dd2d13/models/iotsitewise/service/2019-12-02/iotsitewise-2019-12-02.json
  note: converted by smithy-to-openapi.py from AWS's Smithy model (roadmap#1001)