DescribeProjectResponse

DescribeProjectResponse schema

Asset ManagementIndustrial IoTIoTTime Series Data

Properties

Name Type Description
projectId object
projectArn object
projectName object
portalId object
projectDescription object
projectCreationDate object
projectLastUpdateDate object
View JSON Schema on GitHub

JSON Schema

iot-sitewise-describe-project-response-schema.json Raw ↑
{
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "$id": "https://raw.githubusercontent.com/api-evangelist/amazon-iot-sitewise/refs/heads/main/json-schema/iot-sitewise-describe-project-response-schema.json",
  "title": "DescribeProjectResponse",
  "description": "DescribeProjectResponse schema",
  "type": "object",
  "properties": {
    "projectId": {
      "allOf": [
        {
          "$ref": "#/components/schemas/ID"
        },
        {
          "description": "The ID of the project."
        }
      ]
    },
    "projectArn": {
      "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 project, which has the following format.</p> <p> <code>arn:${Partition}:iotsitewise:${Region}:${Account}:project/${ProjectId}</code> </p>"
        }
      ]
    },
    "projectName": {
      "allOf": [
        {
          "$ref": "#/components/schemas/Name"
        },
        {
          "description": "The name of the project."
        }
      ]
    },
    "portalId": {
      "allOf": [
        {
          "$ref": "#/components/schemas/ID"
        },
        {
          "description": "The ID of the portal that the project is in."
        }
      ]
    },
    "projectDescription": {
      "allOf": [
        {
          "$ref": "#/components/schemas/Description"
        },
        {
          "description": "The project's description."
        }
      ]
    },
    "projectCreationDate": {
      "allOf": [
        {
          "$ref": "#/components/schemas/Timestamp"
        },
        {
          "description": "The date the project was created, in Unix epoch time."
        }
      ]
    },
    "projectLastUpdateDate": {
      "allOf": [
        {
          "$ref": "#/components/schemas/Timestamp"
        },
        {
          "description": "The date the project was last updated, in Unix epoch time."
        }
      ]
    }
  },
  "required": [
    "projectId",
    "projectArn",
    "projectName",
    "portalId",
    "projectCreationDate",
    "projectLastUpdateDate"
  ]
}