CreatePortalResponse

CreatePortalResponse schema

Asset ManagementIndustrial IoTIoTTime Series Data

Properties

Name Type Description
portalId object
portalArn object
portalStartUrl object
portalStatus object
ssoApplicationId object
View JSON Schema on GitHub

JSON Schema

iot-sitewise-create-portal-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-create-portal-response-schema.json",
  "title": "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"
  ]
}