openapi: 3.0.0
info:
  version: '2019-12-02'
  x-release: v4
  title: AWS IoT SiteWise Access Policies Asset Models API
  description: Welcome to the IoT SiteWise API Reference. IoT SiteWise is an Amazon Web Services service that connects <a href="https://en.wikipedia.org/wiki/Internet_of_things#Industrial_applications">Industrial Internet of Things (IIoT)</a> devices to the power of the Amazon Web Services Cloud. For more information, see the <a href="https://docs.aws.amazon.com/iot-sitewise/latest/userguide/">IoT SiteWise User Guide</a>. For information about IoT SiteWise quotas, see <a href="https://docs.aws.amazon.com/iot-sitewise/latest/userguide/quotas.html">Quotas</a> in the <i>IoT SiteWise User Guide</i>.
  x-logo:
    url: https://twitter.com/awscloud/profile_image?size=original
    backgroundColor: '#FFFFFF'
  termsOfService: https://aws.amazon.com/service-terms/
  contact:
    name: Mike Ralphson
    email: mike.ralphson@gmail.com
    url: https://github.com/mermade/aws2openapi
    x-twitter: PermittedSoc
  license:
    name: Apache 2.0 License
    url: http://www.apache.org/licenses/
  x-providerName: amazonaws.com
  x-serviceName: iotsitewise
  x-aws-signingName: iotsitewise
  x-origin:
  - contentType: application/json
    url: https://raw.githubusercontent.com/aws/aws-sdk-js/master/apis/iotsitewise-2019-12-02.normal.json
    converter:
      url: https://github.com/mermade/aws2openapi
      version: 1.0.0
    x-apisguru-driver: external
  x-apiClientRegistration:
    url: https://portal.aws.amazon.com/gp/aws/developer/registration/index.html?nc2=h_ct
  x-apisguru-categories:
  - cloud
  x-preferred: true
servers:
- url: http://iotsitewise.{region}.amazonaws.com
  variables:
    region:
      description: The AWS region
      enum:
      - us-east-1
      - us-east-2
      - us-west-1
      - us-west-2
      - us-gov-west-1
      - us-gov-east-1
      - ca-central-1
      - eu-north-1
      - eu-west-1
      - eu-west-2
      - eu-west-3
      - eu-central-1
      - eu-south-1
      - af-south-1
      - ap-northeast-1
      - ap-northeast-2
      - ap-northeast-3
      - ap-southeast-1
      - ap-southeast-2
      - ap-east-1
      - ap-south-1
      - sa-east-1
      - me-south-1
      default: us-east-1
  description: The AWS IoT SiteWise multi-region endpoint
- url: https://iotsitewise.{region}.amazonaws.com
  variables:
    region:
      description: The AWS region
      enum:
      - us-east-1
      - us-east-2
      - us-west-1
      - us-west-2
      - us-gov-west-1
      - us-gov-east-1
      - ca-central-1
      - eu-north-1
      - eu-west-1
      - eu-west-2
      - eu-west-3
      - eu-central-1
      - eu-south-1
      - af-south-1
      - ap-northeast-1
      - ap-northeast-2
      - ap-northeast-3
      - ap-southeast-1
      - ap-southeast-2
      - ap-east-1
      - ap-south-1
      - sa-east-1
      - me-south-1
      default: us-east-1
  description: The AWS IoT SiteWise multi-region endpoint
- url: http://iotsitewise.{region}.amazonaws.com.cn
  variables:
    region:
      description: The AWS region
      enum:
      - cn-north-1
      - cn-northwest-1
      default: cn-north-1
  description: The AWS IoT SiteWise endpoint for China (Beijing) and China (Ningxia)
- url: https://iotsitewise.{region}.amazonaws.com.cn
  variables:
    region:
      description: The AWS region
      enum:
      - cn-north-1
      - cn-northwest-1
      default: cn-north-1
  description: The AWS IoT SiteWise endpoint for China (Beijing) and China (Ningxia)
security:
- hmac: []
tags:
- name: Asset Models
paths:
  /asset-models:
    parameters:
    - $ref: '#/components/parameters/X-Amz-Content-Sha256'
    - $ref: '#/components/parameters/X-Amz-Date'
    - $ref: '#/components/parameters/X-Amz-Algorithm'
    - $ref: '#/components/parameters/X-Amz-Credential'
    - $ref: '#/components/parameters/X-Amz-Security-Token'
    - $ref: '#/components/parameters/X-Amz-Signature'
    - $ref: '#/components/parameters/X-Amz-SignedHeaders'
    post:
      operationId: CreateAssetModel
      description: Creates an asset model from specified property and hierarchy definitions. You create assets from asset models. With asset models, you can easily create assets of the same type that have standardized definitions. Each asset created from a model inherits the asset model's property and hierarchy definitions. For more information, see <a href="https://docs.aws.amazon.com/iot-sitewise/latest/userguide/define-models.html">Defining asset models</a> in the <i>IoT SiteWise User Guide</i>.
      responses:
        '202':
          description: Success
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/CreateAssetModelResponse'
        '480':
          description: InvalidRequestException
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/InvalidRequestException'
        '481':
          description: ResourceAlreadyExistsException
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ResourceAlreadyExistsException'
        '482':
          description: ResourceNotFoundException
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ResourceNotFoundException'
        '483':
          description: InternalFailureException
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/InternalFailureException'
        '484':
          description: ThrottlingException
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ThrottlingException'
        '485':
          description: LimitExceededException
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/LimitExceededException'
        '486':
          description: ConflictingOperationException
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ConflictingOperationException'
      parameters: []
      requestBody:
        required: true
        content:
          application/json:
            schema:
              type: object
              required:
              - assetModelName
              properties:
                assetModelName:
                  description: A unique, friendly name for the asset model.
                  type: string
                  pattern: '[^\u0000-\u001F\u007F]+'
                  minLength: 1
                  maxLength: 256
                assetModelDescription:
                  description: A description for the asset model.
                  type: string
                  pattern: '[^\u0000-\u001F\u007F]+'
                  minLength: 1
                  maxLength: 2048
                assetModelProperties:
                  description: <p>The property definitions of the asset model. For more information, see <a href="https://docs.aws.amazon.com/iot-sitewise/latest/userguide/asset-properties.html">Asset properties</a> in the <i>IoT SiteWise User Guide</i>.</p> <p>You can specify up to 200 properties per asset model. For more information, see <a href="https://docs.aws.amazon.com/iot-sitewise/latest/userguide/quotas.html">Quotas</a> in the <i>IoT SiteWise User Guide</i>.</p>
                  type: array
                  items:
                    $ref: '#/components/schemas/AssetModelPropertyDefinition'
                assetModelHierarchies:
                  description: <p>The hierarchy definitions of the asset model. Each hierarchy specifies an asset model whose assets can be children of any other assets created from this asset model. For more information, see <a href="https://docs.aws.amazon.com/iot-sitewise/latest/userguide/asset-hierarchies.html">Asset hierarchies</a> in the <i>IoT SiteWise User Guide</i>.</p> <p>You can specify up to 10 hierarchies per asset model. For more information, see <a href="https://docs.aws.amazon.com/iot-sitewise/latest/userguide/quotas.html">Quotas</a> in the <i>IoT SiteWise User Guide</i>.</p>
                  type: array
                  items:
                    $ref: '#/components/schemas/AssetModelHierarchyDefinition'
                assetModelCompositeModels:
                  description: The composite asset models that are part of this asset model. Composite asset models are asset models that contain specific properties. Each composite model has a type that defines the properties that the composite model supports. Use composite asset models to define alarms on this asset model.
                  type: array
                  items:
                    $ref: '#/components/schemas/AssetModelCompositeModelDefinition'
                clientToken:
                  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.
                  type: string
                  pattern: \S{36,64}
                  minLength: 36
                  maxLength: 64
                tags:
                  description: A list of key-value pairs that contain metadata for the asset model. For more information, see <a href="https://docs.aws.amazon.com/iot-sitewise/latest/userguide/tag-resources.html">Tagging your IoT SiteWise resources</a> in the <i>IoT SiteWise User Guide</i>.
                  type: object
                  minProperties: 1
                  maxProperties: 50
                  additionalProperties:
                    $ref: '#/components/schemas/TagValue'
      summary: Amazon IoT SiteWise Create Asset Model
      x-microcks-operation:
        delay: 0
        dispatcher: FALLBACK
      tags:
      - Asset Models
    get:
      operationId: ListAssetModels
      description: Retrieves a paginated list of summaries of all asset models.
      responses:
        '200':
          description: Success
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ListAssetModelsResponse'
        '480':
          description: InvalidRequestException
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/InvalidRequestException'
        '481':
          description: InternalFailureException
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/InternalFailureException'
        '482':
          description: ThrottlingException
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ThrottlingException'
      parameters:
      - name: nextToken
        in: query
        required: false
        description: The token to be used for the next set of paginated results.
        schema:
          type: string
          pattern: '[A-Za-z0-9+/=]+'
          minLength: 1
          maxLength: 4096
      - name: maxResults
        in: query
        required: false
        description: '<p>The maximum number of results to return for each paginated request.</p> <p>Default: 50</p>'
        schema:
          type: integer
          minimum: 1
          maximum: 250
      summary: Amazon IoT SiteWise List Asset Models
      x-microcks-operation:
        delay: 0
        dispatcher: FALLBACK
      tags:
      - Asset Models
  /asset-models/{assetModelId}:
    parameters:
    - $ref: '#/components/parameters/X-Amz-Content-Sha256'
    - $ref: '#/components/parameters/X-Amz-Date'
    - $ref: '#/components/parameters/X-Amz-Algorithm'
    - $ref: '#/components/parameters/X-Amz-Credential'
    - $ref: '#/components/parameters/X-Amz-Security-Token'
    - $ref: '#/components/parameters/X-Amz-Signature'
    - $ref: '#/components/parameters/X-Amz-SignedHeaders'
    delete:
      operationId: DeleteAssetModel
      description: Deletes an asset model. This action can't be undone. You must delete all assets created from an asset model before you can delete the model. Also, you can't delete an asset model if a parent asset model exists that contains a property formula expression that depends on the asset model that you want to delete. For more information, see <a href="https://docs.aws.amazon.com/iot-sitewise/latest/userguide/delete-assets-and-models.html">Deleting assets and models</a> in the <i>IoT SiteWise User Guide</i>.
      responses:
        '202':
          description: Success
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/DeleteAssetModelResponse'
        '480':
          description: InvalidRequestException
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/InvalidRequestException'
        '481':
          description: ResourceNotFoundException
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ResourceNotFoundException'
        '482':
          description: InternalFailureException
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/InternalFailureException'
        '483':
          description: ThrottlingException
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ThrottlingException'
        '484':
          description: ConflictingOperationException
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ConflictingOperationException'
      parameters:
      - name: assetModelId
        in: path
        required: true
        description: The ID of the asset model to delete.
        schema:
          type: string
          pattern: ^[0-9a-f]{8}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{12}$
          minLength: 36
          maxLength: 36
      - name: clientToken
        in: query
        required: false
        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.
        schema:
          type: string
          pattern: \S{36,64}
          minLength: 36
          maxLength: 64
      summary: Amazon IoT SiteWise Delete Asset Model
      x-microcks-operation:
        delay: 0
        dispatcher: FALLBACK
      tags:
      - Asset Models
    get:
      operationId: DescribeAssetModel
      description: Retrieves information about an asset model.
      responses:
        '200':
          description: Success
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/DescribeAssetModelResponse'
        '480':
          description: InvalidRequestException
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/InvalidRequestException'
        '481':
          description: ResourceNotFoundException
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ResourceNotFoundException'
        '482':
          description: InternalFailureException
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/InternalFailureException'
        '483':
          description: ThrottlingException
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ThrottlingException'
      parameters:
      - name: assetModelId
        in: path
        required: true
        description: The ID of the asset model.
        schema:
          type: string
          pattern: ^[0-9a-f]{8}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{12}$
          minLength: 36
          maxLength: 36
      - name: excludeProperties
        in: query
        required: false
        description: ' Whether or not to exclude asset model properties from the response. '
        schema:
          type: boolean
      summary: Amazon IoT SiteWise Describe Asset Model
      x-microcks-operation:
        delay: 0
        dispatcher: FALLBACK
      tags:
      - Asset Models
    put:
      operationId: UpdateAssetModel
      description: <p>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 <a href="https://docs.aws.amazon.com/iot-sitewise/latest/userguide/update-assets-and-models.html">Updating assets and models</a> in the <i>IoT SiteWise User Guide</i>.</p> <important> <p>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 <a href="https://docs.aws.amazon.com/iot-sitewise/latest/APIReference/API_DescribeAssetModel.html">DescribeAssetModel</a>.</p> <p>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.</p> </important>
      responses:
        '202':
          description: Success
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/UpdateAssetModelResponse'
        '480':
          description: InvalidRequestException
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/InvalidRequestException'
        '481':
          description: ResourceAlreadyExistsException
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ResourceAlreadyExistsException'
        '482':
          description: ResourceNotFoundException
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ResourceNotFoundException'
        '483':
          description: InternalFailureException
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/InternalFailureException'
        '484':
          description: LimitExceededException
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/LimitExceededException'
        '485':
          description: ThrottlingException
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ThrottlingException'
        '486':
          description: ConflictingOperationException
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ConflictingOperationException'
      parameters:
      - name: assetModelId
        in: path
        required: true
        description: The ID of the asset model to update.
        schema:
          type: string
          pattern: ^[0-9a-f]{8}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{12}$
          minLength: 36
          maxLength: 36
      requestBody:
        required: true
        content:
          application/json:
            schema:
              type: object
              required:
              - assetModelName
              properties:
                assetModelName:
                  description: A unique, friendly name for the asset model.
                  type: string
                  pattern: '[^\u0000-\u001F\u007F]+'
                  minLength: 1
                  maxLength: 256
                assetModelDescription:
                  description: A description for the asset model.
                  type: string
                  pattern: '[^\u0000-\u001F\u007F]+'
                  minLength: 1
                  maxLength: 2048
                assetModelProperties:
                  description: <p>The updated property definitions of the asset model. For more information, see <a href="https://docs.aws.amazon.com/iot-sitewise/latest/userguide/asset-properties.html">Asset properties</a> in the <i>IoT SiteWise User Guide</i>.</p> <p>You can specify up to 200 properties per asset model. For more information, see <a href="https://docs.aws.amazon.com/iot-sitewise/latest/userguide/quotas.html">Quotas</a> in the <i>IoT SiteWise User Guide</i>.</p>
                  type: array
                  items:
                    $ref: '#/components/schemas/AssetModelProperty'
                assetModelHierarchies:
                  description: <p>The updated hierarchy definitions of the asset model. Each hierarchy specifies an asset model whose assets can be children of any other assets created from this asset model. For more information, see <a href="https://docs.aws.amazon.com/iot-sitewise/latest/userguide/asset-hierarchies.html">Asset hierarchies</a> in the <i>IoT SiteWise User Guide</i>.</p> <p>You can specify up to 10 hierarchies per asset model. For more information, see <a href="https://docs.aws.amazon.com/iot-sitewise/latest/userguide/quotas.html">Quotas</a> in the <i>IoT SiteWise User Guide</i>.</p>
                  type: array
                  items:
                    $ref: '#/components/schemas/AssetModelHierarchy'
                assetModelCompositeModels:
                  description: The composite asset models that are part of this asset model. Composite asset models are asset models that contain specific properties. Each composite model has a type that defines the properties that the composite model supports. Use composite asset models to define alarms on this asset model.
                  type: array
                  items:
                    $ref: '#/components/schemas/AssetModelCompositeModel'
                clientToken:
                  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.
                  type: string
                  pattern: \S{36,64}
                  minLength: 36
                  maxLength: 64
      summary: Amazon IoT SiteWise Update Asset Model
      x-microcks-operation:
        delay: 0
        dispatcher: FALLBACK
      tags:
      - Asset Models
  /asset-models/{assetModelId}/properties:
    parameters:
    - $ref: '#/components/parameters/X-Amz-Content-Sha256'
    - $ref: '#/components/parameters/X-Amz-Date'
    - $ref: '#/components/parameters/X-Amz-Algorithm'
    - $ref: '#/components/parameters/X-Amz-Credential'
    - $ref: '#/components/parameters/X-Amz-Security-Token'
    - $ref: '#/components/parameters/X-Amz-Signature'
    - $ref: '#/components/parameters/X-Amz-SignedHeaders'
    get:
      operationId: 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.
      responses:
        '200':
          description: Success
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ListAssetModelPropertiesResponse'
        '480':
          description: InvalidRequestException
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/InvalidRequestException'
        '481':
          description: InternalFailureException
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/InternalFailureException'
        '482':
          description: ResourceNotFoundException
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ResourceNotFoundException'
        '483':
          description: ThrottlingException
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ThrottlingException'
      parameters:
      - name: assetModelId
        in: path
        required: true
        description: The ID of the asset model.
        schema:
          type: string
          pattern: ^[0-9a-f]{8}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{12}$
          minLength: 36
          maxLength: 36
      - name: nextToken
        in: query
        required: false
        description: The token to be used for the next set of paginated results.
        schema:
          type: string
          pattern: '[A-Za-z0-9+/=]+'
          minLength: 1
          maxLength: 4096
      - name: maxResults
        in: query
        required: false
        description: The maximum number of results to return for each paginated request. If not specified, the default value is 50.
        schema:
          type: integer
          minimum: 1
          maximum: 250
      - name: filter
        in: query
        required: false
        description: '<p> Filters the requested list of asset model properties. You can choose one of the following options:</p> <ul> <li> <p> <code>ALL</code> – The list includes all asset model properties for a given asset model ID. </p> </li> <li> <p> <code>BASE</code> – The list includes only base asset model properties for a given asset model ID. </p> </li> </ul> <p>Default: <code>BASE</code> </p>'
        schema:
          type: string
          enum:
          - ALL
          - BASE
      summary: Amazon IoT SiteWise List Asset Model Properties
      x-microcks-operation:
        delay: 0
        dispatcher: FALLBACK
      tags:
      - Asset Models
components:
  schemas:
    ComputeLocation:
      type: string
      enum:
      - EDGE
      - CLOUD
    Macro:
      type: string
      pattern: '[^\u0000-\u001F\u007F]+'
      minLength: 1
      maxLength: 256
    Expression:
      type: string
      minLength: 1
      maxLength: 1024
    AssetModelHierarchy:
      type: object
      required:
      - name
      - childAssetModelId
      properties:
        id:
          allOf:
          - $ref: '#/components/schemas/ID'
          - description: The ID of the asset model hierarchy. This ID is a <code>hierarchyId</code>.
        name:
          allOf:
          - $ref: '#/components/schemas/Name'
          - description: The name of the asset model hierarchy that you specify by using the <a href="https://docs.aws.amazon.com/iot-sitewise/latest/APIReference/API_CreateAssetModel.html">CreateAssetModel</a> or <a href="https://docs.aws.amazon.com/iot-sitewise/latest/APIReference/API_UpdateAssetModel.html">UpdateAssetModel</a> API operation.
        childAssetModelId:
          allOf:
          - $ref: '#/components/schemas/ID'
          - description: The ID of the asset model. All assets in this hierarchy must be instances of the <code>childAssetModelId</code> asset model.
      description: Describes an asset hierarchy that contains a hierarchy's name, ID, and child asset model ID that specifies the type of asset that can be in this hierarchy.
    DescribeAssetModelResponse:
      type: object
      required:
      - assetModelId
      - assetModelArn
      - assetModelName
      - assetModelDescription
      - assetModelProperties
      - assetModelHierarchies
      - assetModelCreationDate
      - assetModelLastUpdateDate
      - assetModelStatus
      properties:
        assetModelId:
          allOf:
          - $ref: '#/components/schemas/ID'
          - description: The ID of the asset model.
        assetModelArn:
          allOf:
          - $ref: '#/components/schemas/ARN'
          - description: <p>The <a href="https://docs.aws.amazon.com/general/latest/gr/aws-arns-and-namespaces.html">ARN</a> of the asset model, which has the following format.</p> <p> <code>arn:${Partition}:iotsitewise:${Region}:${Account}:asset-model/${AssetModelId}</code> </p>
        assetModelName:
          allOf:
          - $ref: '#/components/schemas/Name'
          - description: The name of the asset model.
        assetModelDescription:
          allOf:
          - $ref: '#/components/schemas/Description'
          - description: The asset model's description.
        assetModelProperties:
          allOf:
          - $ref: '#/components/schemas/AssetModelProperties'
          - description: <p>The list of asset properties for the asset model.</p> <p>This object doesn't include properties that you define in composite models. You can find composite model properties in the <code>assetModelCompositeModels</code> object.</p>
        assetModelHierarchies:
          allOf:
          - $ref: '#/components/schemas/AssetModelHierarchies'
          - description: A list of asset model hierarchies that each contain a <code>childAssetModelId</code> and a <code>hierarchyId</code> (named <code>id</code>). A hierarchy specifies allowed parent/child asset relationships for an asset model.
        assetModelCompositeModels:
          allOf:
          - $ref: '#/components/schemas/AssetModelCompositeModels'
          - description: The list of composite asset models for the asset model.
        assetModelCreationDate:
          allOf:
          - $ref: '#/components/schemas/Timestamp'
          - description: The date the asset model was created, in Unix epoch time.
        assetModelLastUpdateDate:
          allOf:
          - $ref: '#/components/schemas/Timestamp'
          - description: The date the asset model was last updated, in Unix epoch time.
        assetModelStatus:
          allOf:
          - $ref: '#/components/schemas/AssetModelStatus'
          - description: The current status of the asset model, which contains a state and any error message.
    AssetModelCompositeModelDefinition:
      type: object
      required:
      - name
      - type
      properties:
        name:
          allOf:
          - $ref: '#/components/schemas/Name'
          - description: The name of the composite model.
        description:
          allOf:
          - $ref: '#/components/schemas/Description'
          - description: The description of the composite model.
        type:
          allOf:
          - $ref: '#/components/schemas/Name'
          - description: The type of the composite model. For alarm composite models, this type is <code>AWS/ALARM</code>.
        properties:
          description: The asset property definitions for this composite model.
      description: Contains a composite model definition in an asset model. This composite model definition is applied to all assets created from the asset model.
    AssetModelPropertyDefinition:
      type: object
      required:
      - name
      - dataType
      - type
      properties:
        name:
          allOf:
          - $ref: '#/components/schemas/Name'
          - description: The name of the property definition.
        dataType:
          allOf:
          - $ref: '#/components/schemas/PropertyDataType'
          - description: <p>The data type of the property definition.</p> <p>If you specify <code>STRUCT</code>, you must also specify <code>dataTypeSpec</code> to identify the type of the structure for this property.</p>
        dataTypeSpec:
          allOf:
          - $ref: '#/components/schemas/Name'
          - description: <p>The data type of the structure for this property. This parameter is required on properties that have the <code>STRUCT</code> data type.</p> <p>The options for this parameter depend on the type of the composite model in which you define this property. Use <code>AWS/ALARM_STATE</code> for alarm state in alarm composite models.</p>
        unit:
          allOf:
          - $ref: '#/components/schemas/PropertyUnit'
          - description: The unit of the property definition, such as <code>Newtons</code> or <code>RPM</code>.
        type:
          allOf:
          - $ref: '#/components/schemas/PropertyType'
          - description: The property definition type (see <code>PropertyType</code>). You can only specify one type in a property definition.
      description: Contains an asset model property definition. This property definition is applied to all assets created from the asset model.
    AssetModelSummaries:
      type: array
      items:
        $ref: '#/components/schemas/AssetModelSummary'
    InternalFailureException: {}
    AssetModelProperties:
      type: array
      items:
        $ref: '#/components/schemas/AssetModelProperty'
    AssetModelCompositeModel:
      type: object
      required:
      - name
      - type
      properties:
        name:
          allOf:
          - $ref: '#/components/schemas/Name'
          - description: The name of the composite model.
        description:
          allOf:
          - $ref: '#/components/schemas/Description'
          - description: The description of the composite model.
        type:
          allOf:
          - $ref: '#/components/schemas/Name'
          - description: The type of the composite model. For alarm composite models, this type is <code>AWS/ALARM</code>.
        properties:
          description: The asset property definitions for this composite model.
        id:
          allOf:
          - $ref: '#/components/schemas/ID'
          - description: ' The ID of the asset model composite model. '
      description: Contains information about a composite model in an asset model. This object contains the asset property definitions that you define in the composite model.
    ForwardingConfig:
      type: object
      required:
      - state
      properties:
        state:
          allOf:
          - $ref: '#/components/schemas/ForwardingConfigState'
          - description: 'The forwarding state for the given property. '
      description: The forwarding configuration for a given property.
    TransformProcessingConfig:
      type: object
      required:
      - computeLocation
      properties:
        computeLocation:
          allOf:
          - $ref: '#/components/schemas/ComputeLocation'
          - description: 'The compute location for the given transform property. '
        forwardingConfig:
          $ref: '#/components/schemas/ForwardingConfig'
      description: The processing configuration for the given transform property. You can configure transforms to be kept at the edge or forwarded to the Amazon Web Services Cloud. You can also configure transforms to be computed at the edge or in the cloud.
    Timestamp:
      type: string
      format: date-time
    Measurement:
      type: object
      properties:
        processingConfig:
          allOf:
          - $ref: '#/components/schemas/MeasurementProcessingConfig'
          - description: The processing configuration for the given measurement property. You can configure measurements to be kept at the edge or forwarded to the Amazon Web Services Cloud. By default, measurements are forwarded to the cloud.
      description: Contains an asset measurement property. For more information, see <a href="https://docs.aws.amazon.com/iot-sitewise/latest/userguide/asset-properties.html#measurements">Measurements</a> in the <i>IoT SiteWise User Guide</i>.
    UpdateAssetModelResponse:
      type: object
      required:
      - assetModelStatus
      properties:
        assetModelStatus:
          allOf:
          - $ref: '#/components/schemas/AssetModelStatus'
          - description: The status of the asset model, which contains a state (<code>UPDATING</code> after successfully calling this operation) and any error message.
    AssetModelHierarchies:
      type: array
      items:
        $ref: '#/components/schemas/AssetModelHierarchy'
    DetailedErrorMessage:
      type: string
    ForwardingConfigState:
      type: string
      enum:
      - DISABLED
      - ENABLED
    ExpressionVariable:
      type: object
      required:
      - name
      - value
      properties:
        name:
          allOf:
          - $ref: '#/components/schemas/VariableName'
          - description: The friendly name of the variable to be used in the expression.
        value:
          allOf:
          - $ref: '#/components/schemas/VariableValue'
          - description: The variable that identifies an asset property from which to use values.
      description: Contains expression variable information.
    TagValue:
      type: string
      minLength: 0
      maxLength: 256
    PropertyDataType:
      type: string
      enum:
      - STRING
      - INTEGER
      - DOUBLE
      - BOOLEAN
      - STRUCT
    AssetModelProperty:
      type: object
      required:
      - name
      - dataType
      - type
      properties:
        id:
          allOf:
          - $ref: '#/components/schemas/ID'
          - description: The ID of the asset model property.
        name:
          allOf:
          - $ref: '#/components/schemas/Name'
          - description: The name of the asset model property.
        dataType:
          allOf:
          - $ref: '#/components/schemas/PropertyDataType'
          - description: The data type of the asset model property.
        dataTypeSpec:
          allOf:
          - $ref: '#/components/schemas/Name'
          - description: The data type of the structure for this property. This parameter exists on properties that have the <code>STRUCT</code> data type.
        unit:
          allOf:
          - $ref: '#/components/schemas/PropertyUnit'
          - description: The unit of the asset model property, such as <code>Newtons</code> or <code>RPM</code>.
        type:
          allOf:
          - $ref: '#/components/schemas/PropertyType'
          - description: The property type (see <code>PropertyType</code>).
      description: Contains information about an asset model property.
    Attribute:
      type: object
      properties:
        defaultValue:
          allOf:
          - $ref: '#/components/schemas/DefaultValue'
          - description: The default value of the asset model property attribute. All assets that you create from the asset model contain this attribute value. You can update an attribute's value after you create an asset. For more information, see <a href="https://docs.aws.amazon.com/iot-sitewise/latest/userguide/update-attribute-values.html">Updating attribute values</a> in the <i>IoT SiteWise User Guide</i>.
      description: Contains an asset attribute property. For more information, see <a href="https://docs.aws.amazon.com/iot-sitewise/latest/userguide/asset-properties.html#attributes">Attributes</a> in the <i>IoT SiteWise User Guide</i>.
    ListAssetModelPropertiesResponse:
      type: object
      required:
      - assetModelPropertySummaries
      properties:
        assetModelPropertySummaries:
          allOf:
          - $ref: '#/components/schemas/AssetModelPropertySummaries'
          - description: A list that summarizes the properties associated with the specified asset model.
        nextToken:
          allOf:
          - $ref: '#/components/schemas/NextToken'
          - description: The token for the next set of results, or null if there are no additional results.
    InvalidRequestException: {}
    LimitExceededException: {}
    ConflictingOperationException: {}
    AssetModelState:
      type: string
      enum:
      - CREATING
      - ACTIVE
      - UPDATING
      - PROPAGATING
      - DELETING
      - FAILED
    AssetModelPropertySummaries:
      type: array
      items:
        $ref: '#/components/schemas/AssetModelPropertySummary'
    PropertyType:
      type: object
      properties:
        attribute:
          allOf:
          - $ref: '#/components/schemas/Attribute'
          - description: Specifies an asset attribute property. An attribute generally contains static information, such as the serial number of an <a href="https://en.wikipedia.org/wiki/Internet_of_things#Industrial_applications">IIoT</a> wind turbine.
        measurement:
          allOf:
          - $ref: '#/components/schemas/Measurement'
          - description: Specifies an asset measurement property. A measurement represents a device's raw sensor data stream, such as timestamped temperature values or timestamped power values.
        transform:
          allOf:
          - $ref: '#/components/schemas/Transform'
          - description: Specifies an asset transform property. A transform contains a mathematical expression that maps a property's data points from one form to another, such as a unit conversion from Celsius to Fahrenheit.
        metric:
          allOf:
          - $ref: '#/components/schemas/Metric'
          - description: Specifies an asset metric property. A metric contains a mathematical expression that uses aggregate functions to process all input data points over a time interval and output a single data point, such as to calculate the average hourly temperature.
      description: Contains a property type, which can be one of <code>attribute</code>, <code>measurement</code>, <code>metric</code>, or <code>transform</code>.
    AssetModelStatus:
      type: object
      required:
      - state
      properties:
        state:
          allOf:
          - $ref: '#/components/schemas/AssetModelState'
          - description: The current state of the asset model.
        error:
          allOf:
          - $ref: '#/components/schemas/ErrorDetails'
          - description: Contains associated error information, if any.
      description: Contains current status information for an asset model. For more information, see <a href="https://docs.aws.amazon.com/iot-sitewise/latest/userguide/asset-and-model-states.html">Asset and model states</a> in the <i>IoT SiteWise User Guide</i>.
    MetricProcessingConfig:
      type: object
      required:
      - computeLocation
      properties:
        computeLocation:
          allOf:
          - $ref: '#/components/schemas/ComputeLocation'
          - description: 'The compute location for the given metric property. '
      description: The processing configuration for the given metric property. You can configure metrics to be computed at the edge or in the Amazon Web Services Cloud. By default, metrics are forwarded to the cloud.
    MeasurementProcessingConfig:
      type: object
      required:
      - forwardingConfig
      properties:
        forwardingConfig:
          allOf:
          - $ref: '#/components/schemas/ForwardingConfig'
          - description: 'The forwarding configuration for the given measurement property. '
      description: The processing configuration for the given measurement property. You can configure measurements to be kept at the edge or forwarded to the Amazon Web Services Cloud. By default, measurements are forwarded to the cloud.
    DeleteAssetModelResponse:
      type: object
      required:
      - assetModelStatus
      properties:
        assetModelStatus:
          allOf:
          - $ref: '#/components/schemas/AssetModelStatus'
          - description: The status of the asset model, which contains a state (<code>DELETING</code> after successfully calling this operation) and any error message.
    DetailedErrorCode:
      type: string
      enum:
      - INCOMPATIBLE_COMPUTE_LOCATION
      - INCOMPATIBLE_FORWARDING_CONFIGURATION
    AssetModelHierarchyDefinition:
      type: object
      required:
      - name
      - childAssetModelId
      properties:
        name:
          allOf:
          - $ref: '#/components/schemas/Name'
          - description: The name of the asset model hierarchy definition (as specified in the <a href="https://docs.aws.amazon.com/iot-sitewise/latest/APIReference/API_CreateAssetModel.html">CreateAssetModel</a> or <a href="https://docs.aws.amazon.com/iot-sitewise/latest/APIReference/API_UpdateAssetModel.html">UpdateAssetModel</a> API operation).
        childAssetModelId:
          allOf:
          - $ref: '#/components/schemas/ID'
          - description: The ID of an asset model for this hierarchy.
      description: Contains an asset model hierarchy used in asset model creation. An asset model hierarchy determines the kind (or type) of asset that can belong to a hierarchy.
    Interval:
      type: string
      minLength: 2
      maxLength: 23
    PropertyUnit:
      type: string
      pattern: '[^\u0000-\u001F\u007F]+'
      minLength: 1
      maxLength: 256
    ExpressionVariables:
      type: array
      items:
        $ref: '#/components/schemas/ExpressionVariable'
    AssetModelPropertySummary:
      type: object
      required:
      - name
      - dataType
      - type
      properties:
        id:
          allOf:
          - $ref: '#/components/schemas/ID'
          - description: The ID of the property.
        name:
          allOf:
          - $ref: '#/components/schemas/Name'
          - description: The name of the property.
        dataType:
          allOf:
          - $ref: '#/components/schemas/PropertyDataType'
          - description: The data type of the property.
        dataTypeSpec:
          allOf:
          - $ref: '#/components/schemas/Name'
          - description: The data type of the structure for this property. This parameter exists on properties that have the <code>STRUCT</code> data type.
        unit:
          allOf:
          - $ref: '#/components/schemas/PropertyUnit'
          - description: The unit (such as <code>Newtons</code> or <code>RPM</code>) of the property.
        type:
          $ref: '#/components/schemas/PropertyType'
        assetModelCompositeModelId:
          allOf:
          - $ref: '#/components/schemas/ID'
          - description: ' The ID of the composite model that contains the asset model property. '
      description: Contains a summary of a property associated with a model.
    ResourceAlreadyExistsException: {}
    Description:
      type: string
      pattern: '[^\u0000-\u001F\u007F]+'
      minLength: 1
      maxLength: 2048
    ErrorDetails:
      type: object
      required:
      - code
      - message
      properties:
        code:
          allOf:
          - $ref: '#/components/schemas/ErrorCode'
          - description: The error code.
        message:
          allOf:
          - $ref: '#/components/schemas/ErrorMessage'
          - description: The error message.
        details:
          allOf:
          - $ref: '#/components/schemas/DetailedErrors'
          - description: ' A list of detailed errors. '
      description: Contains the details of an IoT SiteWise error.
    ErrorMessage:
      type: string
    Offset:
      type: string
      minLength: 2
      maxLength: 25
    AssetModelSummary:
      type: object
      required:
      - id
      - arn
      - name
      - description
      - creationDate
      - lastUpdateDate
      - status
      properties:
        id:
          allOf:
          - $ref: '#/components/schemas/ID'
          - description: The ID of the asset model (used with IoT SiteWise APIs).
        arn:
          allOf:
          - $ref: '#/components/schemas/ARN'
          - description: <p>The <a href="https://docs.aws.amazon.com/general/latest/gr/aws-arns-and-namespaces.html">ARN</a> of the asset model, which has the following format.</p> <p> <code>arn:${Partition}:iotsitewise:${Region}:${Account}:asset-model/${AssetModelId}</code> </p>
        name:
          allOf:
          - $ref: '#/components/schemas/Name'
          - description: The name of the asset model.
        description:
          allOf:
          - $ref: '#/components/schemas/Description'
          - description: The asset model description.
        creationDate:
          allOf:
          - $ref: '#/components/schemas/Timestamp'
          - description: The date the asset model was created, in Unix epoch time.
        lastUpdateDate:
          allOf:
          - $ref: '#/components/schemas/Timestamp'
          - description: The date the asset model was last updated, in Unix epoch time.
        status:
          allOf:
          - $ref: '#/components/schemas/AssetModelStatus'
          - description: The current status of the asset model.
      description: Contains a summary of an asset model.
    Name:
      type: string
      pattern: '[^\u0000-\u001F\u007F]+'
      minLength: 1
      maxLength: 256
    ListAssetModelsResponse:
      type: object
      required:
      - assetModelSummaries
      properties:
        assetModelSummaries:
          allOf:
          - $ref: '#/components/schemas/AssetModelSummaries'
          - description: A list that summarizes each asset model.
        nextToken:
          allOf:
          - $ref: '#/components/schemas/NextToken'
          - description: The token for the next set of results, or null if there are no additional results.
    DetailedError:
      type: object
      required:
      - code
      - message
      properties:
        code:
          allOf:
          - $ref: '#/components/schemas/DetailedErrorCode'
          - description: 'The error code. '
        message:
          allOf:
          - $ref: '#/components/schemas/DetailedErrorMessage'
          - description: 'The error message. '
      description: 'Contains detailed error information. '
    DetailedErrors:
      type: array
      items:
        $ref: '#/components/schemas/DetailedError'
    MetricWindow:
      type: object
      properties:
        tumbling:
          allOf:
          - $ref: '#/components/schemas/TumblingWindow'
          - description: The tumbling time interval window.
      description: Contains a time interval window used for data aggregate computations (for example, average, sum, count, and so on).
    DefaultValue:
      type: string
      pattern: '[^\u0000-\u001F\u007F]+'
      minLength: 1
      maxLength: 1024
    TumblingWindow:
      type: object
      required:
      - interval
      properties:
        interval:
          allOf:
          - $ref: '#/components/schemas/Interval'
          - description: <p>The time interval for the tumbling window. The interval time must be between 1 minute and 1 week.</p> <p>IoT SiteWise computes the <code>1w</code> interval the end of Sunday at midnight each week (UTC), the <code>1d</code> interval at the end of each day at midnight (UTC), the <code>1h</code> interval at the end of each hour, and so on. </p> <p>When IoT SiteWise aggregates data points for metric computations, the start of each interval is exclusive and the end of each interval is inclusive. IoT SiteWise places the computed data point at the end of the interval.</p>
        offset:
          allOf:
          - $ref: '#/components/schemas/Offset'
          - description: <p>The offset for the tumbling window. The <code>offset</code> parameter accepts the following:</p> <ul> <li> <p>The offset time.</p> <p>For example, if you specify <code>18h</code> for <code>offset</code> and <code>1d</code> for <code>interval</code>, IoT SiteWise aggregates data in one of the following ways:</p> <ul> <li> <p>If you create the metric before or at 6 PM (UTC), you get the first aggregation result at 6 PM (UTC) on the day when you create the metric.</p> </li> <li> <p>If you create the metric after 6 PM (UTC), you get the first aggregation result at 6 PM (UTC) the next day.</p> </li> </ul> </li> <li> <p>The ISO 8601 format.</p> <p>For example, if you specify <code>PT18H</code> for <code>offset</code> and <code>1d</code> for <code>interval</code>, IoT SiteWise aggregates data in one of the following ways:</p> <ul> <li> <p>If you create the metric before or at 6 PM (UTC), you get the first aggregation result at 6 PM (UTC) on the day when you create the metric.</p> </li> <li> <p>If you create the metric after 6 PM (UTC), you get the first aggregation result at 6 PM (UTC) the next day.</p> </li> </ul> </li> <li> <p>The 24-hour clock.</p> <p>For example, if you specify <code>00:03:00</code> for <code>offset</code>, <code>5m</code> for <code>interval</code>, and you create the metric at 2 PM (UTC), you get the first aggregation result at 2:03 PM (UTC). You get the second aggregation result at 2:08 PM (UTC). </p> </li> <li> <p>The offset time zone.</p> <p>For example, if you specify <code>2021-07-23T18:00-08</code> for <code>offset</code> and <code>1d</code> for <code>interval</code>, IoT SiteWise aggregates data in one of the following ways:</p> <ul> <li> <p>If you create the metric before or at 6 PM (PST), you get the first aggregation result at 6 PM (PST) on the day when you create the metric.</p> </li> <li> <p>If you create the metric after 6 PM (PST), you get the first aggregation result at 6 PM (PST) the next day.</p> </li> </ul> </li> </ul>
      description: <p>Contains a tumbling window, which is a repeating fixed-sized, non-overlapping, and contiguous time window. You can use this window in metrics to aggregate data from properties and other assets.</p> <p>You can use <code>m</code>, <code>h</code>, <code>d</code>, and <code>w</code> when you specify an interval or offset. Note that <code>m</code> represents minutes, <code>h</code> represents hours, <code>d</code> represents days, and <code>w</code> represents weeks. You can also use <code>s</code> to represent seconds in <code>offset</code>.</p> <p>The <code>interval</code> and <code>offset</code> parameters support the <a href="https://en.wikipedia.org/wiki/ISO_8601">ISO 8601 format</a>. For example, <code>PT5S</code> represents 5 seconds, <code>PT5M</code> represents 5 minutes, and <code>PT5H</code> represents 5 hours.</p>
    ID:
      type: string
      pattern: ^[0-9a-f]{8}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{12}$
      minLength: 36
      maxLength: 36
    ErrorCode:
      type: string
      enum:
      - VALIDATION_ERROR
      - INTERNAL_FAILURE
    VariableName:
      type: string
      pattern: ^[a-z][a-z0-9_]*$
      minLength: 1
      maxLength: 64
    AssetModelCompositeModels:
      type: array
      items:
        $ref: '#/components/schemas/AssetModelCompositeModel'
    VariableValue:
      type: object
      required:
      - propertyId
      properties:
        propertyId:
          allOf:
          - $ref: '#/components/schemas/Macro'
          - description: The ID of the property to use as the variable. You can use the property <code>name</code> if it's from the same asset model.
        hierarchyId:
          allOf:
          - $ref: '#/components/schemas/Macro'
          - description: <p>The ID of the hierarchy to query for the property ID. You can use the hierarchy's name instead of the hierarchy's ID.</p> <p>You use a hierarchy ID instead of a model ID because you can have several hierarchies using the same model and therefore the same <code>propertyId</code>. For example, you might have separately grouped assets that come from the same asset model. For more information, see <a href="https://docs.aws.amazon.com/iot-sitewise/latest/userguide/asset-hierarchies.html">Asset hierarchies</a> in the <i>IoT SiteWise User Guide</i>.</p>
      description: Identifies a property value used in an expression.
    ThrottlingException: {}
    Transform:
      type: object
      required:
      - expression
      - variables
      properties:
        expression:
          allOf:
          - $ref: '#/components/schemas/Expression'
          - description: <p>The mathematical expression that defines the transformation function. You can specify up to 10 variables per expression. You can specify up to 10 functions per expression. </p> <p>For more information, see <a href="https://docs.aws.amazon.com/iot-sitewise/latest/userguide/quotas.html">Quotas</a> in the <i>IoT SiteWise User Guide</i>.</p>
        variables:
          allOf:
          - $ref: '#/components/schemas/ExpressionVariables'
          - description: The list of variables used in the expression.
        processingConfig:
          allOf:
          - $ref: '#/components/schemas/TransformProcessingConfig'
          - description: The processing configuration for the given transform property. You can configure transforms to be kept at the edge or forwarded to the Amazon Web Services Cloud. You can also configure transforms to be computed at the edge or in the cloud.
      description: <p>Contains an asset transform property. A transform is a one-to-one mapping of a property's data points from one form to another. For example, you can use a transform to convert a Celsius data stream to Fahrenheit by applying the transformation expression to each data point of the Celsius stream. A transform can only have a data type of <code>DOUBLE</code> and consume properties with data types of <code>INTEGER</code> or <code>DOUBLE</code>.</p> <p>For more information, see <a href="https://docs.aws.amazon.com/iot-sitewise/latest/userguide/asset-properties.html#transforms">Transforms</a> in the <i>IoT SiteWise User Guide</i>.</p>
    CreateAssetModelResponse:
      type: object
      required:
      - assetModelId
      - assetModelArn
      - assetModelStatus
      properties:
        assetModelId:
          allOf:
          - $ref: '#/components/schemas/ID'
          - description: The ID of the asset model. You can use this ID when you call other IoT SiteWise APIs.
        assetModelArn:
          allOf:
          - $ref: '#/components/schemas/ARN'
          - description: <p>The <a href="https://docs.aws.amazon.com/general/latest/gr/aws-arns-and-namespaces.html">ARN</a> of the asset model, which has the following format.</p> <p> <code>arn:${Partition}:iotsitewise:${Region}:${Account}:asset-model/${AssetModelId}</code> </p>
        assetModelStatus:
          allOf:
          - $ref: '#/components/schemas/AssetModelStatus'
          - description: The status of the asset model, which contains a state (<code>CREATING</code> after successfully calling this operation) and any error message.
    ResourceNotFoundException: {}
    NextToken:
      type: string
      pattern: '[A-Za-z0-9+/=]+'
      minLength: 1
      maxLength: 4096
    Metric:
      type: object
      required:
      - expression
      - variables
      - window
      properties:
        expression:
          allOf:
          - $ref: '#/components/schemas/Expression'
          - description: <p>The mathematical expression that defines the metric aggregation function. You can specify up to 10 variables per expression. You can specify up to 10 functions per expression. </p> <p>For more information, see <a href="https://docs.aws.amazon.com/iot-sitewise/latest/userguide/quotas.html">Quotas</a> in the <i>IoT SiteWise User Guide</i>.</p>
        variables:
          allOf:
          - $ref: '#/components/schemas/ExpressionVariables'
          - description: The list of variables used in the expression.
        window:
          allOf:
          - $ref: '#/components/schemas/MetricWindow'
          - description: The window (time interval) over which IoT SiteWise computes the metric's aggregation expression. IoT SiteWise computes one data point per <code>window</code>.
        processingConfig:
          allOf:
          - $ref: '#/components/schemas/MetricProcessingConfig'
          - description: The processing configuration for the given metric property. You can configure metrics to be computed at the edge or in the Amazon Web Services Cloud. By default, metrics are forwarded to the cloud.
      description: <p>Contains an asset metric property. With metrics, you can calculate aggregate functions, such as an average, maximum, or minimum, as specified through an expression. A metric maps several values to a single value (such as a sum).</p> <p>The maximum number of dependent/cascading variables used in any one metric calculation is 10. Therefore, a <i>root</i> metric can have up to 10 cascading metrics in its computational dependency tree. Additionally, a metric can only have a data type of <code>DOUBLE</code> and consume properties with data types of <code>INTEGER</code> or <code>DOUBLE</code>.</p> <p>For more information, see <a href="https://docs.aws.amazon.com/iot-sitewise/latest/userguide/asset-properties.html#metrics">Metrics</a> in the <i>IoT SiteWise User Guide</i>.</p>
    ARN:
      type: string
      pattern: .*
      minLength: 1
      maxLength: 1600
  parameters:
    X-Amz-Content-Sha256:
      name: X-Amz-Content-Sha256
      in: header
      schema:
        type: string
      required: false
    X-Amz-Algorithm:
      name: X-Amz-Algorithm
      in: header
      schema:
        type: string
      required: false
    X-Amz-Credential:
      name: X-Amz-Credential
      in: header
      schema:
        type: string
      required: false
    X-Amz-Security-Token:
      name: X-Amz-Security-Token
      in: header
      schema:
        type: string
      required: false
    X-Amz-Signature:
      name: X-Amz-Signature
      in: header
      schema:
        type: string
      required: false
    X-Amz-Date:
      name: X-Amz-Date
      in: header
      schema:
        type: string
      required: false
    X-Amz-SignedHeaders:
      name: X-Amz-SignedHeaders
      in: header
      schema:
        type: string
      required: false
  securitySchemes:
    hmac:
      type: apiKey
      name: Authorization
      in: header
      description: Amazon Signature authorization v4
      x-amazon-apigateway-authtype: awsSigv4
externalDocs:
  description: Amazon Web Services documentation
  url: https://docs.aws.amazon.com/iotsitewise/
x-hasEquivalentPaths: true