Amazon IoT SiteWise · JSON Structure

Iot Sitewise Create Portal Response Structure

CreatePortalResponse schema

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

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

Properties

portalId portalArn portalStartUrl portalStatus ssoApplicationId

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-portal-response-structure.json",
  "name": "CreatePortalResponse",
  "description": "CreatePortalResponse schema",
  "type": "object",
  "properties": {
    "portalId": {
      "allOf": [
        {
          "$ref": "#/components/schemas/ID"
        },
        {
          "description": "The ID of the created portal."
        }
      ]
    },
    "portalArn": {
      "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 portal, which has the following format.</p> <p> <code>arn:${Partition}:iotsitewise:${Region}:${Account}:portal/${PortalId}</code> </p>"
        }
      ]
    },
    "portalStartUrl": {
      "allOf": [
        {
          "$ref": "#/components/schemas/Url"
        },
        {
          "description": "The URL for the IoT SiteWise Monitor portal. You can use this URL to access portals that use IAM Identity Center for authentication. For portals that use IAM for authentication, you must use the IoT SiteWise console to get a URL that you can use to access the portal."
        }
      ]
    },
    "portalStatus": {
      "allOf": [
        {
          "$ref": "#/components/schemas/PortalStatus"
        },
        {
          "description": "The status of the portal, which contains a state (<code>CREATING</code> after successfully calling this operation) and any error message."
        }
      ]
    },
    "ssoApplicationId": {
      "allOf": [
        {
          "$ref": "#/components/schemas/SSOApplicationId"
        },
        {
          "description": "The associated IAM Identity Center application ID, if the portal uses IAM Identity Center."
        }
      ]
    }
  },
  "required": [
    "portalId",
    "portalArn",
    "portalStartUrl",
    "portalStatus",
    "ssoApplicationId"
  ]
}