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"
  ]
}

Work with this as data

Every JSON Structure here is available over the APIs.io API and to AI agents over MCP.

MCP server

One button, every client — Claude, Cursor, VS Code and the rest.

https://apis.io/mcp

Tools for json structure

4 MCP tools reach this
  • find_json_structuresBrowse and filter every JSON Structure in the catalog.
  • apis_io_searchSTART HERE — APIs, providers and tags for one query, each with its total.
  • resolveTurn a domain, URL or GitHub org into the provider it belongs to.
  • find_cohortsEvery scored population of providers in the catalog.
All 92 tools →

Call it yourself

curl for this page
This JSON Structure
curl "https://apis.io/api/v1/json-structures/iot-sitewise-create-portal-response-structure"
All json structure
curl "https://apis.io/api/v1/json-structures?limit=25"

Discovery needs no key. Ratings and market analysis are Pro.

Get an API key

Free tier, no form to fill in. Signing in shares your email address with us — we store it to create your key and to recognise you if you sign in with another provider. See our Privacy Policy and Terms.

A second provider on the same verified email joins the account you already have.