Amazon Web Services Asset Models API

The Asset Models API from Amazon Web Services — 6 operation(s) for asset models.

OpenAPI Specification

amazon-web-services-asset-models-api-openapi.yml Raw ↑
openapi: 3.1.0
info:
  title: Amazon Web Services accessanalyzer 2012 09 25 Asset Models API
  description: <p>Identity and Access Management Access Analyzer helps you to set, verify, and refine your IAM policies by providing a suite of capabilities. Its features include findings for external and unused access, basic and custom policy checks for validating policies, and policy generation to generate fine-grained policies. To start using IAM Access Analyzer to identify external or unused access, you first need to create an analyzer.</p> <p> <b>External access analyzers</b> help identify potential risks of accessing resources by enabling you to identify any resource policies that grant access to an external principal. It does this by using logic-based reasoning to analyze resource-based policies in your Amazon Web Services environment. An external principal can be another Amazon Web Services account, a root user, an IAM user or role, a federated user, an Amazon Web Services service, or an anonymous user. You can also use IAM Access Analyzer to preview public and cross-account access to your resources before deploying permissions changes.</p> <p> <b>Unused access analyzers</b> help identify potential identity access risks by enabling you to identify unused IAM roles, unused access keys, unused console passwords, and IAM principals with unused service and action-level permissions.</p> <p>Beyond findings, IAM Access Analyzer provides basic and custom policy checks to validate IAM policies before deploying permissions changes. You can use policy generation to refine permissions by attaching a policy generated using access activity logged in CloudTrail logs. </p> <p>This guide describes the IAM Access Analyzer operations that you can call programmatically. For general information about IAM Access Analyzer, see <a href="https://docs.aws.amazon.com/IAM/latest/UserGuide/what-is-access-analyzer.html">Identity and Access Management Access Analyzer</a> in the <b>IAM User Guide</b>.</p>
tags:
- name: Asset Models
paths:
  /asset-models:
    GET:
      summary: Amazon Web Services Listassetmodels
      description: Retrieves a paginated list of summaries of all asset models.
      operationId: amazonWebServicesListAssetModels
      tags:
      - Asset Models
  /asset-models/{assetModelId}/composite-models:
    GET:
      summary: Amazon Web Services Listassetmodelcompositemodels
      description: Retrieves a paginated list of composite models associated with the asset model
      operationId: amazonWebServicesListAssetModelCompositeModels
      tags:
      - Asset Models
  /asset-models/{assetModelId}:
    PUT:
      summary: Amazon Web Services Updateassetmodel
      description: 'Updates an asset model and all of the assets that were created from the model. Each asset created from the model inherits the updated asset model''s property and hierarchy definitions. For more information, see Updating assets and models in the IoT SiteWise User Guide.  This operation overwrites the existing model with the provided model. To avoid deleting your asset model''s properties or hierarchies, you must include their IDs and definitions in the updated asset model payload. For more information, see DescribeAssetModel. If you remove a property from an asset model, IoT SiteWise deletes all previous data for that property. If you remove a hierarchy definition from an asset model, IoT SiteWise disassociates every asset associated with that hierarchy. You can''t change the type or data type of an existing property. '
      operationId: amazonWebServicesUpdateAssetModel
      tags:
      - Asset Models
  /asset-models/{assetModelId}/composite-models/{assetModelCompositeModelId}:
    PUT:
      summary: Amazon Web Services Updateassetmodelcompositemodel
      description: 'Updates a composite model and all of the assets that were created from the model. Each asset created from the model inherits the updated asset model''s property and hierarchy definitions. For more information, see Updating assets and models in the IoT SiteWise User Guide.  If you remove a property from a composite asset model, IoT SiteWise deletes all previous data for that property. You can’t change the type or data type of an existing property. To replace an existing composite asset model property with a new one with the same name, do the following:   Submit an UpdateAssetModelCompositeModel request with the entire existing property removed.   Submit a second UpdateAssetModelCompositeModel request that includes the new property. The new asset property will have the same name as the previous one and IoT SiteWise will generate a new unique id.   '
      operationId: amazonWebServicesUpdateAssetModelCompositeModel
      tags:
      - Asset Models
  /asset-models/{assetModelId}/properties:
    GET:
      summary: Amazon Web Services Listassetmodelproperties
      description: Retrieves a paginated list of properties associated with an asset model. If you update properties associated with the model before you finish listing all the properties, you need to start all over again.
      operationId: amazonWebServicesListAssetModelProperties
      tags:
      - Asset Models
  /asset-models/{assetModelId}/composition-relationships:
    GET:
      summary: Amazon Web Services Listcompositionrelationships
      description: Retrieves a paginated list of composition relationships for an asset model of type COMPONENT_MODEL.
      operationId: amazonWebServicesListCompositionRelationships
      tags:
      - Asset Models