Amazon Web Services Assets API

openapi: 3.2.0
info:
  title: Amazon Web Services Assets API
  version: '1.0'
  description: 'Operations tagged Assets across 2 of this provider''s published API definitions: iotsitewise-openapi-original.yml, mediapackage-vod-openapi-original.yml. Each path carries the servers of the definition it was published in.'
tags:
- name: Assets
paths:
  /assets/{assetId}/associate:
    POST:
      summary: Amazon Web Services Associateassets
      description: Associates a child asset with the given parent asset through a hierarchy defined in the parent asset's model. For more information, see Associating assets in the IoT SiteWise User Guide.
      operationId: amazonWebServicesAssociateAssets
      tags:
      - Assets
  /assets:
    GET:
      summary: Amazon Web Services Listassets
      description: 'Retrieves a paginated list of asset summaries. You can use this operation to do the following: List assets based on a specific asset model. List top-level assets. You can''t use this operation to list all assets. To retrieve summaries for all of your assets, use ListAssetModels to get all of your asset model IDs. Then, use ListAssets to get all assets for each asset model.'
      operationId: amazonWebServicesListAssets
      tags:
      - Assets
  /assets/{assetId}:
    PUT:
      summary: Amazon Web Services Updateasset
      description: Updates an asset's name. For more information, see Updating assets and models in the IoT SiteWise User Guide.
      operationId: amazonWebServicesUpdateAsset
      tags:
      - Assets
  /assets/{assetId}/composite-models/{assetCompositeModelId}:
    GET:
      summary: Amazon Web Services Describeassetcompositemodel
      description: Retrieves information about an asset composite model (also known as an asset component). An AssetCompositeModel is an instance of an AssetModelCompositeModel. If you want to see information about the model this is based on, call DescribeAssetModelCompositeModel.
      operationId: amazonWebServicesDescribeAssetCompositeModel
      tags:
      - Assets
  /assets/{assetId}/properties/{propertyId}:
    PUT:
      summary: Amazon Web Services Updateassetproperty
      description: Updates an asset property's alias and notification state. This operation overwrites the property's existing alias and notification state. To keep your existing property's alias or notification state, you must include the existing values in the UpdateAssetProperty request. For more information, see DescribeAssetProperty.
      operationId: amazonWebServicesUpdateAssetProperty
      tags:
      - Assets
  /assets/{assetId}/disassociate:
    POST:
      summary: Amazon Web Services Disassociateassets
      description: Disassociates a child asset from the given parent asset through a hierarchy defined in the parent asset's model.
      operationId: amazonWebServicesDisassociateAssets
      tags:
      - Assets
  /assets/{assetId}/properties:
    GET:
      summary: Amazon Web Services Listassetproperties
      description: Retrieves a paginated list of properties associated with an asset. If you update properties associated with the model before you finish listing all the properties, you need to start all over again.
      operationId: amazonWebServicesListAssetProperties
      tags:
      - Assets
  /assets/{assetId}/assetRelationships:
    GET:
      summary: Amazon Web Services Listassetrelationships
      description: Retrieves a paginated list of asset relationships for an asset. You can use this operation to identify an asset's root asset and all associated assets between that asset and its root.
      operationId: amazonWebServicesListAssetRelationships
      tags:
      - Assets
  /assets/{assetId}/hierarchies:
    GET:
      summary: Amazon Web Services Listassociatedassets
      description: 'Retrieves a paginated list of associated assets. You can use this operation to do the following: List child assets associated to a parent asset by a hierarchy that you specify. List an asset''s parent asset.'
      operationId: amazonWebServicesListAssociatedAssets
      tags:
      - Assets
  /assets/{id}:
    GET:
      summary: Amazon Web Services Describeasset
      description: Returns a description of a MediaPackage VOD Asset resource.
      operationId: amazonWebServicesDescribeAsset
      tags:
      - Assets
x-refined-from:
- iotsitewise-openapi-original.yml
- mediapackage-vod-openapi-original.yml