openapi: 3.0.0
info:
  version: '2019-12-02'
  x-release: v4
  title: AWS IoT SiteWise Access Policies Assets 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: Assets
paths:
  /assets/{assetId}/associate:
    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: 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 <a href="https://docs.aws.amazon.com/iot-sitewise/latest/userguide/add-associated-assets.html">Associating assets</a> in the <i>IoT SiteWise User Guide</i>.
      responses:
        '200':
          description: Success
        '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: assetId
        in: path
        required: true
        description: The ID of the parent asset.
        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:
              - hierarchyId
              - childAssetId
              properties:
                hierarchyId:
                  description: The ID of a hierarchy in the parent asset's model. Hierarchies allow different groupings of assets to be formed that all 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>.
                  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
                childAssetId:
                  description: The ID of the child asset to be associated.
                  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
                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 Associate Assets
      x-microcks-operation:
        delay: 0
        dispatcher: FALLBACK
      tags:
      - Assets
  /assets:
    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: CreateAsset
      description: Creates an asset from an existing asset model. For more information, see <a href="https://docs.aws.amazon.com/iot-sitewise/latest/userguide/create-assets.html">Creating assets</a> in the <i>IoT SiteWise User Guide</i>.
      responses:
        '202':
          description: Success
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/CreateAssetResponse'
        '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:
              - assetName
              - assetModelId
              properties:
                assetName:
                  description: A friendly name for the asset.
                  type: string
                  pattern: '[^\u0000-\u001F\u007F]+'
                  minLength: 1
                  maxLength: 256
                assetModelId:
                  description: The ID of the asset model from which to create the asset.
                  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
                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. 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'
                assetDescription:
                  description: A description for the asset.
                  type: string
                  pattern: '[^\u0000-\u001F\u007F]+'
                  minLength: 1
                  maxLength: 2048
      summary: Amazon IoT SiteWise Create Asset
      x-microcks-operation:
        delay: 0
        dispatcher: FALLBACK
      tags:
      - Assets
    get:
      operationId: ListAssets
      description: <p>Retrieves a paginated list of asset summaries.</p> <p>You can use this operation to do the following:</p> <ul> <li> <p>List assets based on a specific asset model.</p> </li> <li> <p>List top-level assets.</p> </li> </ul> <p>You can't use this operation to list all assets. To retrieve summaries for all of your assets, use <a href="https://docs.aws.amazon.com/iot-sitewise/latest/APIReference/API_ListAssetModels.html">ListAssetModels</a> to get all of your asset model IDs. Then, use ListAssets to get all assets for each asset model.</p>
      responses:
        '200':
          description: Success
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ListAssetsResponse'
        '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: 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
      - name: assetModelId
        in: query
        required: false
        description: The ID of the asset model by which to filter the list of assets. This parameter is required if you choose <code>ALL</code> for <code>filter</code>.
        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: filter
        in: query
        required: false
        description: '<p>The filter for the requested list of assets. Choose one of the following options:</p> <ul> <li> <p> <code>ALL</code> – The list includes all assets for a given asset model ID. The <code>assetModelId</code> parameter is required if you filter by <code>ALL</code>.</p> </li> <li> <p> <code>TOP_LEVEL</code> – The list includes only top-level assets in the asset hierarchy tree.</p> </li> </ul> <p>Default: <code>ALL</code> </p>'
        schema:
          type: string
          enum:
          - ALL
          - TOP_LEVEL
      summary: Amazon IoT SiteWise List Assets
      x-microcks-operation:
        delay: 0
        dispatcher: FALLBACK
      tags:
      - Assets
  /assets/{assetId}:
    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: DeleteAsset
      description: <p>Deletes an asset. This action can't be undone. 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>. </p> <note> <p>You can't delete an asset that's associated to another asset. For more information, see <a href="https://docs.aws.amazon.com/iot-sitewise/latest/APIReference/API_DisassociateAssets.html">DisassociateAssets</a>.</p> </note>
      responses:
        '202':
          description: Success
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/DeleteAssetResponse'
        '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: assetId
        in: path
        required: true
        description: The ID of the asset 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
      x-microcks-operation:
        delay: 0
        dispatcher: FALLBACK
      tags:
      - Assets
    get:
      operationId: DescribeAsset
      description: Retrieves information about an asset.
      responses:
        '200':
          description: Success
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/DescribeAssetResponse'
        '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: assetId
        in: path
        required: true
        description: The ID of the asset.
        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 properties from the response. '
        schema:
          type: boolean
      summary: Amazon IoT SiteWise Describe Asset
      x-microcks-operation:
        delay: 0
        dispatcher: FALLBACK
      tags:
      - Assets
    put:
      operationId: UpdateAsset
      description: Updates an asset's name. 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>.
      responses:
        '202':
          description: Success
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/UpdateAssetResponse'
        '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: ConflictingOperationException
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ConflictingOperationException'
      parameters:
      - name: assetId
        in: path
        required: true
        description: The ID of the asset 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:
              - assetName
              properties:
                assetName:
                  description: A friendly name for the asset.
                  type: string
                  pattern: '[^\u0000-\u001F\u007F]+'
                  minLength: 1
                  maxLength: 256
                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
                assetDescription:
                  description: A description for the asset.
                  type: string
                  pattern: '[^\u0000-\u001F\u007F]+'
                  minLength: 1
                  maxLength: 2048
      summary: Amazon IoT SiteWise Update Asset
      x-microcks-operation:
        delay: 0
        dispatcher: FALLBACK
      tags:
      - Assets
  /assets/{assetId}/properties/{propertyId}:
    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: DescribeAssetProperty
      description: <p>Retrieves information about an asset property.</p> <note> <p>When you call this operation for an attribute property, this response includes the default attribute value that you define in the asset model. If you update the default value in the model, this operation's response includes the new default value.</p> </note> <p>This operation doesn't return the value of the asset property. To get the value of an asset property, use <a href="https://docs.aws.amazon.com/iot-sitewise/latest/APIReference/API_GetAssetPropertyValue.html">GetAssetPropertyValue</a>.</p>
      responses:
        '200':
          description: Success
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/DescribeAssetPropertyResponse'
        '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: assetId
        in: path
        required: true
        description: The ID of the asset.
        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: propertyId
        in: path
        required: true
        description: The ID of the asset property.
        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
      summary: Amazon IoT SiteWise Describe Asset Property
      x-microcks-operation:
        delay: 0
        dispatcher: FALLBACK
      tags:
      - Assets
    put:
      operationId: UpdateAssetProperty
      description: <p>Updates an asset property's alias and notification state.</p> <important> <p>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 <a href="https://docs.aws.amazon.com/iot-sitewise/latest/APIReference/API_DescribeAssetProperty.html">DescribeAssetProperty</a>.</p> </important>
      responses:
        '200':
          description: Success
        '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: assetId
        in: path
        required: true
        description: The ID of the asset to be updated.
        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: propertyId
        in: path
        required: true
        description: The ID of the asset property to be updated.
        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
              properties:
                propertyAlias:
                  description: <p>The alias that identifies the property, such as an OPC-UA server data stream path (for example, <code>/company/windfarm/3/turbine/7/temperature</code>). For more information, see <a href="https://docs.aws.amazon.com/iot-sitewise/latest/userguide/connect-data-streams.html">Mapping industrial data streams to asset properties</a> in the <i>IoT SiteWise User Guide</i>.</p> <p>If you omit this parameter, the alias is removed from the property.</p>
                  type: string
                  pattern: '[^\u0000-\u001F\u007F]+'
                  minLength: 1
                propertyNotificationState:
                  description: <p>The MQTT notification state (enabled or disabled) for this asset property. When the notification state is enabled, IoT SiteWise publishes property value updates to a unique MQTT topic. For more information, see <a href="https://docs.aws.amazon.com/iot-sitewise/latest/userguide/interact-with-other-services.html">Interacting with other services</a> in the <i>IoT SiteWise User Guide</i>.</p> <p>If you omit this parameter, the notification state is set to <code>DISABLED</code>.</p>
                  type: string
                  enum:
                  - ENABLED
                  - DISABLED
                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
                propertyUnit:
                  description: The unit of measure (such as Newtons or RPM) of the asset property. If you don't specify a value for this parameter, the service uses the value of the <code>assetModelProperty</code> in the asset model.
                  type: string
                  pattern: '[^\u0000-\u001F\u007F]+'
                  minLength: 1
                  maxLength: 256
      summary: Amazon IoT SiteWise Update Asset Property
      x-microcks-operation:
        delay: 0
        dispatcher: FALLBACK
      tags:
      - Assets
  /assets/{assetId}/disassociate:
    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: DisassociateAssets
      description: Disassociates a child asset from the given parent asset through a hierarchy defined in the parent asset's model.
      responses:
        '200':
          description: Success
        '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: assetId
        in: path
        required: true
        description: The ID of the parent asset from which to disassociate the child asset.
        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:
              - hierarchyId
              - childAssetId
              properties:
                hierarchyId:
                  description: The ID of a hierarchy in the parent asset's model. Hierarchies allow different groupings of assets to be formed that all come from the same asset model. You can use the hierarchy ID to identify the correct asset to disassociate. 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>.
                  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
                childAssetId:
                  description: The ID of the child asset to disassociate.
                  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
                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 Disassociate Assets
      x-microcks-operation:
        delay: 0
        dispatcher: FALLBACK
      tags:
      - Assets
  /assets/{assetId}/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: 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.
      responses:
        '200':
          description: Success
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ListAssetPropertiesResponse'
        '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: assetId
        in: path
        required: true
        description: The ID of the asset.
        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 properties. You can choose one of the following options:</p> <ul> <li> <p> <code>ALL</code> – The list includes all asset properties for a given asset model ID. </p> </li> <li> <p> <code>BASE</code> – The list includes only base asset 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 Properties
      x-microcks-operation:
        delay: 0
        dispatcher: FALLBACK
      tags:
      - Assets
  /assets/{assetId}/assetRelationships#traversalType:
    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: 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.
      responses:
        '200':
          description: Success
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ListAssetRelationshipsResponse'
        '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: assetId
        in: path
        required: true
        description: The ID of the asset.
        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: traversalType
        in: query
        required: true
        description: <p>The type of traversal to use to identify asset relationships. Choose the following option:</p> <ul> <li> <p> <code>PATH_TO_ROOT</code> – Identify the asset's parent assets up to the root asset. The asset that you specify in <code>assetId</code> is the first result in the list of <code>assetRelationshipSummaries</code>, and the root asset is the last result.</p> </li> </ul>
        schema:
          type: string
          enum:
          - PATH_TO_ROOT
      - 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.
        schema:
          type: integer
          minimum: 1
          maximum: 250
      summary: Amazon IoT SiteWise List Asset Relationships
      x-microcks-operation:
        delay: 0
        dispatcher: FALLBACK
      tags:
      - Assets
  /assets/{assetId}/hierarchies:
    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: ListAssociatedAssets
      description: <p>Retrieves a paginated list of associated assets.</p> <p>You can use this operation to do the following:</p> <ul> <li> <p>List child assets associated to a parent asset by a hierarchy that you specify.</p> </li> <li> <p>List an asset's parent asset.</p> </li> </ul>
      responses:
        '200':
          description: Success
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ListAssociatedAssetsResponse'
        '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: assetId
        in: path
        required: true
        description: The ID of the asset to query.
        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: hierarchyId
        in: query
        required: false
        description: <p>The ID of the hierarchy by which child assets are associated to the asset. To find a hierarchy ID, use the <a href="https://docs.aws.amazon.com/iot-sitewise/latest/APIReference/API_DescribeAsset.html">DescribeAsset</a> or <a href="https://docs.aws.amazon.com/iot-sitewise/latest/APIReference/API_DescribeAssetModel.html">DescribeAssetModel</a> operations. This parameter is required if you choose <code>CHILD</code> for <code>traversalDirection</code>.</p> <p>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>
        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: traversalDirection
        in: query
        required: false
        description: '<p>The direction to list associated assets. Choose one of the following options:</p> <ul> <li> <p> <code>CHILD</code> – The list includes all child assets associated to the asset. The <code>hierarchyId</code> parameter is required if you choose <code>CHILD</code>.</p> </li> <li> <p> <code>PARENT</code> – The list includes the asset''s parent asset.</p> </li> </ul> <p>Default: <code>CHILD</code> </p>'
        schema:
          type: string
          enum:
          - PARENT
          - CHILD
      - 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 Associated Assets
      x-microcks-operation:
        delay: 0
        dispatcher: FALLBACK
      tags:
      - Assets
components:
  schemas:
    ComputeLocation:
      type: string
      enum:
      - EDGE
      - CLOUD
    Macro:
      type: string
      pattern: '[^\u0000-\u001F\u007F]+'
      minLength: 1
      maxLength: 256
    AssetCompositeModels:
      type: array
      items:
        $ref: '#/components/schemas/AssetCompositeModel'
    InternalFailureException: {}
    AssociatedAssetsSummaries:
      type: array
      items:
        $ref: '#/components/schemas/AssociatedAssetsSummary'
    AssetSummaries:
      type: array
      items:
        $ref: '#/components/schemas/AssetSummary'
    DescribeAssetPropertyResponse:
      type: object
      required:
      - assetId
      - assetName
      - assetModelId
      properties:
        assetId:
          allOf:
          - $ref: '#/components/schemas/ID'
          - description: The ID of the asset.
        assetName:
          allOf:
          - $ref: '#/components/schemas/Name'
          - description: The name of the asset.
        assetModelId:
          allOf:
          - $ref: '#/components/schemas/ID'
          - description: The ID of the asset model.
        assetProperty:
          allOf:
          - $ref: '#/components/schemas/Property'
          - description: <p>The asset property's definition, alias, and notification state.</p> <p>This response includes this object for normal asset properties. If you describe an asset property in a composite model, this response includes the asset property information in <code>compositeModel</code>.</p>
        compositeModel:
          allOf:
          - $ref: '#/components/schemas/CompositeModelProperty'
          - description: The composite asset model that declares this asset property, if this asset property exists in a composite model.
    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>.
    ConflictingOperationException: {}
    LimitExceededException: {}
    CreateAssetResponse:
      type: object
      required:
      - assetId
      - assetArn
      - assetStatus
      properties:
        assetId:
          allOf:
          - $ref: '#/components/schemas/ID'
          - description: The ID of the asset. This ID uniquely identifies the asset within IoT SiteWise and can be used with other IoT SiteWise APIs.
        assetArn:
          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, which has the following format.</p> <p> <code>arn:${Partition}:iotsitewise:${Region}:${Account}:asset/${AssetId}</code> </p>
        assetStatus:
          allOf:
          - $ref: '#/components/schemas/AssetStatus'
          - description: The status of the asset, which contains a state (<code>CREATING</code> after successfully calling this operation) and any error message.
    PropertyAlias:
      type: string
      pattern: '[^\u0000-\u001F\u007F]+'
      minLength: 1
    AssetHierarchyInfo:
      type: object
      properties:
        parentAssetId:
          allOf:
          - $ref: '#/components/schemas/ID'
          - description: The ID of the parent asset in this asset relationship.
        childAssetId:
          allOf:
          - $ref: '#/components/schemas/ID'
          - description: The ID of the child asset in this asset relationship.
      description: Contains information about a parent asset and a child asset that are related through an asset hierarchy.
    AssetRelationshipSummary:
      type: object
      required:
      - relationshipType
      properties:
        hierarchyInfo:
          allOf:
          - $ref: '#/components/schemas/AssetHierarchyInfo'
          - description: <p>The assets that are related through an asset hierarchy.</p> <p>This object is present if the <code>relationshipType</code> is <code>HIERARCHY</code>.</p>
        relationshipType:
          allOf:
          - $ref: '#/components/schemas/AssetRelationshipType'
          - description: <p>The relationship type of the assets in this relationship. This value is one of the following:</p> <ul> <li> <p> <code>HIERARCHY</code> – The assets are related through an asset hierarchy. If you specify this relationship type, this asset relationship includes the <code>hierarchyInfo</code> object.</p> </li> </ul>
      description: Contains information about assets that are related to one another.
    Description:
      type: string
      pattern: '[^\u0000-\u001F\u007F]+'
      minLength: 1
      maxLength: 2048
    ErrorMessage:
      type: string
    AssetHierarchy:
      type: object
      required:
      - name
      properties:
        id:
          allOf:
          - $ref: '#/components/schemas/ID'
          - description: The ID of the hierarchy. This ID is a <code>hierarchyId</code>.
        name:
          allOf:
          - $ref: '#/components/schemas/Name'
          - description: The hierarchy name provided 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.
      description: Describes an asset hierarchy that contains a hierarchy's name and ID.
    Offset:
      type: string
      minLength: 2
      maxLength: 25
    CompositeModelProperty:
      type: object
      required:
      - name
      - type
      - assetProperty
      properties:
        name:
          allOf:
          - $ref: '#/components/schemas/Name'
          - description: The name of the property.
        type:
          allOf:
          - $ref: '#/components/schemas/Name'
          - description: The type of the composite model that defines this property.
        assetProperty:
          $ref: '#/components/schemas/Property'
        id:
          allOf:
          - $ref: '#/components/schemas/ID'
          - description: ' The ID of the composite model that contains the property. '
      description: Contains information about a composite model property on an asset.
    ListAssetRelationshipsResponse:
      type: object
      required:
      - assetRelationshipSummaries
      properties:
        assetRelationshipSummaries:
          allOf:
          - $ref: '#/components/schemas/AssetRelationshipSummaries'
          - description: A list that summarizes each asset relationship.
        nextToken:
          allOf:
          - $ref: '#/components/schemas/NextToken'
          - description: The token for the next set of results, or null if there are no additional results.
    AssetStatus:
      type: object
      required:
      - state
      properties:
        state:
          allOf:
          - $ref: '#/components/schemas/AssetState'
          - description: The current status of the asset.
        error:
          allOf:
          - $ref: '#/components/schemas/ErrorDetails'
          - description: Contains associated error information, if any.
      description: Contains information about the current status of an asset. 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>.
    UpdateAssetResponse:
      type: object
      required:
      - assetStatus
      properties:
        assetStatus:
          allOf:
          - $ref: '#/components/schemas/AssetStatus'
          - description: The status of the asset, which contains a state (<code>UPDATING</code> after successfully calling this operation) and any error message.
    VariableName:
      type: string
      pattern: ^[a-z][a-z0-9_]*$
      minLength: 1
      maxLength: 64
    AssetPropertySummaries:
      type: array
      items:
        $ref: '#/components/schemas/AssetPropertySummary'
    AssetState:
      type: string
      enum:
      - CREATING
      - ACTIVE
      - UPDATING
      - DELETING
      - FAILED
    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.
    AssetProperty:
      type: object
      required:
      - id
      - name
      - dataType
      properties:
        id:
          allOf:
          - $ref: '#/components/schemas/ID'
          - description: The ID of the asset property.
        name:
          allOf:
          - $ref: '#/components/schemas/Name'
          - description: The name of the property.
        alias:
          allOf:
          - $ref: '#/components/schemas/PropertyAlias'
          - description: The alias that identifies the property, such as an OPC-UA server data stream path (for example, <code>/company/windfarm/3/turbine/7/temperature</code>). For more information, see <a href="https://docs.aws.amazon.com/iot-sitewise/latest/userguide/connect-data-streams.html">Mapping industrial data streams to asset properties</a> in the <i>IoT SiteWise User Guide</i>.
        notification:
          allOf:
          - $ref: '#/components/schemas/PropertyNotification'
          - description: The asset property's notification topic and state. For more information, see <a href="https://docs.aws.amazon.com/iot-sitewise/latest/APIReference/API_UpdateAssetProperty.html">UpdateAssetProperty</a>.
        dataType:
          allOf:
          - $ref: '#/components/schemas/PropertyDataType'
          - description: The data type of the asset 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 asset property.
      description: Contains asset property information.
    Property:
      type: object
      required:
      - id
      - name
      - dataType
      properties:
        id:
          allOf:
          - $ref: '#/components/schemas/ID'
          - description: The ID of the asset property.
        name:
          allOf:
          - $ref: '#/components/schemas/Name'
          - description: The name of the property.
        alias:
          allOf:
          - $ref: '#/components/schemas/PropertyAlias'
          - description: The alias that identifies the property, such as an OPC-UA server data stream path (for example, <code>/company/windfarm/3/turbine/7/temperature</code>). For more information, see <a href="https://docs.aws.amazon.com/iot-sitewise/latest/userguide/connect-data-streams.html">Mapping industrial data streams to asset properties</a> in the <i>IoT SiteWise User Guide</i>.
        notification:
          allOf:
          - $ref: '#/components/schemas/PropertyNotification'
          - description: The asset property's notification topic and state. For more information, see <a href="https://docs.aws.amazon.com/iot-sitewise/latest/APIReference/API_UpdateAssetProperty.html">UpdateAssetProperty</a>.
        dataType:
          allOf:
          - $ref: '#/components/schemas/PropertyDataType'
          - description: The property data type.
        unit:
          allOf:
          - $ref: '#/components/schemas/PropertyUnit'
          - description: The unit (such as <code>Newtons</code> or <code>RPM</code>) of the asset property.
        type:
          allOf:
          - $ref: '#/components/schemas/PropertyType'
          - description: The property type (see <code>PropertyType</code>). A property contains one type.
      description: Contains asset property information.
    PropertyNotificationState:
      type: string
      enum:
      - ENABLED
      - DISABLED
    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.
    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.
    DetailedErrorCode:
      type: string
      enum:
      - INCOMPATIBLE_COMPUTE_LOCATION
      - INCOMPATIBLE_FORWARDING_CONFIGURATION
    ExpressionVariables:
      type: array
      items:
        $ref: '#/components/schemas/ExpressionVariable'
    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.
    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).
    AssetRelationshipType:
      type: string
      enum:
      - HIERARCHY
    ErrorCode:
      type: string
      enum:
      - VALIDATION_ERROR
      - INTERNAL_FAILURE
    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: {}
    AssetHierarchies:
      type: array
      items:
        $ref: '#/components/schemas/AssetHierarchy'
    NextToken:
      type: string
      pattern: '[A-Za-z0-9+/=]+'
      minLength: 1
      maxLength: 4096
    AssetCompositeModel:
      type: object
      required:
      - name
      - type
      - properties
      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 properties that this composite model defines.
        id:
          allOf:
          - $ref: '#/components/schemas/ID'
          - description: ' The ID of the asset composite model. '
      description: Contains information about a composite model in an asset. This object contains the asset's properties that you define in the composite model.
    PropertyNotificationTopic:
      type: string
    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>.
    DescribeAssetResponse:
      type: object
      required:
      - assetId
      - assetArn
      - assetName
      - assetModelId
      - assetProperties
      - assetHierarchies
      - assetCreationDate
      - assetLastUpdateDate
      - assetStatus
      properties:
        assetId:
          allOf:
          - $ref: '#/components/schemas/ID'
          - description: The ID of the asset.
        assetArn:
          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, which has the following format.</p> <p> <code>arn:${Partition}:iotsitewise:${Region}:${Account}:asset/${AssetId}</code> </p>
        assetName:
          allOf:
          - $ref: '#/components/schemas/Name'
          - description: The name of the asset.
        assetModelId:
          allOf:
          - $ref: '#/components/schemas/ID'
          - description: The ID of the asset model that was used to create the asset.
        assetProperties:
          allOf:
          - $ref: '#/components/schemas/AssetProperties'
          - description: <p>The list of asset properties for the asset.</p> <p>This object doesn't include properties that you define in composite models. You can find composite model properties in the <code>assetCompositeModels</code> object.</p>
        assetHierarchies:
          allOf:
          - $ref: '#/components/schemas/AssetHierarchies'
          - description: A list of asset hierarchies that each contain a <code>hierarchyId</code>. A hierarchy specifies allowed parent/child asset relationships.
        assetCompositeModels:
          allOf:
          - $ref: '#/components/schemas/AssetCompositeModels'
          - description: The composite models for the asset.
        assetCreationDate:
          allOf:
          - $ref: '#/components/schemas/Timestamp'
          - description: The date the asset was created, in Unix epoch time.
        assetLastUpdateDate:
          allOf:
          - $ref: '#/components/schemas/Timestamp'
          - description: The date the asset was last updated, in Unix epoch time.
        assetStatus:
          allOf:
          - $ref: '#/components/schemas/AssetStatus'
          - description: The current status of the asset, which contains a state and any error message.
        assetDescription:
          allOf:
          - $ref: '#/components/schemas/Description'
          - description: A description for the asset.
    PropertyDataType:
      type: string
      enum:
      - STRING
      - INTEGER
      - DOUBLE
      - BOOLEAN
      - STRUCT
    InvalidRequestException: {}
    AssetPropertySummary:
      type: object
      properties:
        id:
          allOf:
          - $ref: '#/components/schemas/ID'
          - description: The ID of the property.
        alias:
          allOf:
          - $ref: '#/components/schemas/PropertyAlias'
          - description: The alias that identifies the property, such as an OPC-UA server data stream path (for example, <code>/company/windfarm/3/turbine/7/temperature</code>). For more information, see <a href="https://docs.aws.amazon.com/iot-sitewise/latest/userguide/connect-data-streams.html">Mapping industrial data streams to asset properties</a> in the <i>IoT SiteWise User Guide</i>.
        unit:
          allOf:
          - $ref: '#/components/schemas/PropertyUnit'
          - description: ' The unit of measure (such as Newtons or RPM) of the asset property. '
        notification:
          $ref: '#/components/schemas/PropertyNotification'
        assetCompositeModelId:
          allOf:
          - $ref: '#/components/schemas/ID'
          - description: ' The ID of the composite model that contains the asset property. '
      description: Contains a summary of a property associated with an asset.
    AssetRelationshipSummaries:
      type: array
      items:
        $ref: '#/components/schemas/AssetRelationshipSummary'
    ResourceAlreadyExistsException: {}
    DefaultValue:
      type: string
      pattern: '[^\u0000-\u001F\u007F]+'
      minLength: 1
      maxLength: 1024
    DetailedErrors:
      type: array
      items:
        $ref: '#/components/schemas/DetailedError'
    PropertyNotification:
      type: object
      required:
      - topic
      - state
      properties:
        topic:
          allOf:
          - $ref: '#/components/schemas/PropertyNotificationTopic'
          - description: The MQTT topic to which IoT SiteWise publishes property value update notifications.
        state:
          allOf:
          - $ref: '#/components/schemas/PropertyNotificationState'
          - description: The current notification state.
      description: Contains asset property value notification information. When the notification state is enabled, IoT SiteWise publishes property value updates to a unique MQTT topic. For more information, see <a href="https://docs.aws.amazon.com/iot-sitewise/latest/userguide/interact-with-other-services.html">Interacting with other services</a> in the <i>IoT SiteWise User Guide</i>.
    AssociatedAssetsSummary:
      type: object
      required:
      - id
      - arn
      - name
      - assetModelId
      - creationDate
      - lastUpdateDate
      - status
      - hierarchies
      properties:
        id:
          allOf:
          - $ref: '#/components/schemas/ID'
          - description: The ID of the asset.
        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, which has the following format.</p> <p> <code>arn:${Partition}:iotsitewise:${Region}:${Account}:asset/${AssetId}</code> </p>
        name:
          allOf:
          - $ref: '#/components/schemas/Name'
          - description: The name of the asset.
        assetModelId:
          allOf:
          - $ref: '#/components/schemas/ID'
          - description: The ID of the asset model used to create the asset.
        creationDate:
          allOf:
          - $ref: '#/components/schemas/Timestamp'
          - description: The date the asset was created, in Unix epoch time.
        lastUpdateDate:
          allOf:
          - $ref: '#/components/schemas/Timestamp'
          - description: The date the asset was last updated, in Unix epoch time.
        status:
          allOf:
          - $ref: '#/components/schemas/AssetStatus'
          - description: The current status of the asset.
        hierarchies:
          allOf:
          - $ref: '#/components/schemas/AssetHierarchies'
          - description: A list of asset hierarchies that each contain a <code>hierarchyId</code>. A hierarchy specifies allowed parent/child asset relationships.
        description:
          allOf:
          - $ref: '#/components/schemas/Description'
          - description: A description for the asset.
      description: Contains a summary of an associated asset.
    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>.
    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>
    ResourceNotFoundException: {}
    ARN:
      type: string
      pattern: .*
      minLength: 1
      maxLength: 1600
    Expression:
      type: string
      minLength: 1
      maxLength: 1024
    ListAssociatedAssetsResponse:
      type: object
      required:
      - assetSummaries
      properties:
        assetSummaries:
          allOf:
          - $ref: '#/components/schemas/AssociatedAssetsSummaries'
          - description: A list that summarizes the associated assets.
        nextToken:
          allOf:
          - $ref: '#/components/schemas/NextToken'
          - description: The token for the next set of results, or null if there are no additional results.
    AssetSummary:
      type: object
      required:
      - id
      - arn
      - name
      - assetModelId
      - creationDate
      - lastUpdateDate
      - status
      - hierarchies
      properties:
        id:
          allOf:
          - $ref: '#/components/schemas/ID'
          - description: The ID of the asset.
        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, which has the following format.</p> <p> <code>arn:${Partition}:iotsitewise:${Region}:${Account}:asset/${AssetId}</code> </p>
        name:
          allOf:
          - $ref: '#/components/schemas/Name'
          - description: The name of the asset.
        assetModelId:
          allOf:
          - $ref: '#/components/schemas/ID'
          - description: The ID of the asset model used to create this asset.
        creationDate:
          allOf:
          - $ref: '#/components/schemas/Timestamp'
          - description: The date the asset was created, in Unix epoch time.
        lastUpdateDate:
          allOf:
          - $ref: '#/components/schemas/Timestamp'
          - description: The date the asset was last updated, in Unix epoch time.
        status:
          allOf:
          - $ref: '#/components/schemas/AssetStatus'
          - description: The current status of the asset.
        hierarchies:
          allOf:
          - $ref: '#/components/schemas/AssetHierarchies'
          - description: A list of asset hierarchies that each contain a <code>hierarchyId</code>. A hierarchy specifies allowed parent/child asset relationships.
        description:
          allOf:
          - $ref: '#/components/schemas/Description'
          - description: A description for the asset.
      description: Contains a summary of an asset.
    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
    AssetProperties:
      type: array
      items:
        $ref: '#/components/schemas/AssetProperty'
    ListAssetsResponse:
      type: object
      required:
      - assetSummaries
      properties:
        assetSummaries:
          allOf:
          - $ref: '#/components/schemas/AssetSummaries'
          - description: A list that summarizes each asset.
        nextToken:
          allOf:
          - $ref: '#/components/schemas/NextToken'
          - description: The token for the next set of results, or null if there are no additional results.
    Interval:
      type: string
      minLength: 2
      maxLength: 23
    PropertyUnit:
      type: string
      pattern: '[^\u0000-\u001F\u007F]+'
      minLength: 1
      maxLength: 256
    Name:
      type: string
      pattern: '[^\u0000-\u001F\u007F]+'
      minLength: 1
      maxLength: 256
    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. '
    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>
    ListAssetPropertiesResponse:
      type: object
      required:
      - assetPropertySummaries
      properties:
        assetPropertySummaries:
          allOf:
          - $ref: '#/components/schemas/AssetPropertySummaries'
          - description: A list that summarizes the properties associated with the specified asset.
        nextToken:
          allOf:
          - $ref: '#/components/schemas/NextToken'
          - description: The token for the next set of results, or null if there are no additional results.
    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
    DeleteAssetResponse:
      type: object
      required:
      - assetStatus
      properties:
        assetStatus:
          allOf:
          - $ref: '#/components/schemas/AssetStatus'
          - description: The status of the asset, which contains a state (<code>DELETING</code> after successfully calling this operation) and any error message.
    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>
  parameters:
    X-Amz-Algorithm:
      name: X-Amz-Algorithm
      in: header
      schema:
        type: string
      required: false
    X-Amz-SignedHeaders:
      name: X-Amz-SignedHeaders
      in: header
      schema:
        type: string
      required: false
    X-Amz-Content-Sha256:
      name: X-Amz-Content-Sha256
      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-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
  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