Amazon IoT SiteWise · JSON Structure

Iot Sitewise Create Asset Response Structure

CreateAssetResponse schema

Type: object Properties: 3 Required: 3
Asset ManagementIndustrial IoTIoTTime Series Data

CreateAssetResponse is a JSON Structure definition published by Amazon IoT SiteWise, describing 3 properties, of which 3 are required. It conforms to the https://json-structure.org/meta/core/v0/# meta-schema.

Properties

assetId assetArn assetStatus

Meta-schema: https://json-structure.org/meta/core/v0/#

JSON Structure

Raw ↑ 
{
  "$schema": "https://json-structure.org/meta/core/v0/#",
  "$id": "https://raw.githubusercontent.com/api-evangelist/amazon-iot-sitewise/refs/heads/main/json-structure/iot-sitewise-create-asset-response-structure.json",
  "name": "CreateAssetResponse",
  "description": "CreateAssetResponse schema",
  "type": "object",
  "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."
        }
      ]
    }
  },
  "required": [
    "assetId",
    "assetArn",
    "assetStatus"
  ]
}