PUT

/portals/{portalId}

http://iotsitewise.{region}.amazonaws.com/portals/{portalId}

Updates an IoT SiteWise Monitor portal.

Access Token Required: API Key

Path Parameters

portalIdstringrequired

The ID of the portal to update.

Body Params

alarmsobject

Contains the configuration information of an alarm created in an IoT SiteWise Monitor portal. You can use the alarm to monitor an asset property and get notified when the asset property value is outside a specified range. For more information, see <a href="https://docs.aws.amazon.com/iot-sitewise/latest/appguide/monitor-alarms.html">Monitoring with alarms</a> in the IoT SiteWise Application Guide.

roleArnstringrequired

The <a href="https://docs.aws.amazon.com/general/latest/gr/aws-arns-and-namespaces.html">ARN</a> of a service role that allows the portal's users to access your IoT SiteWise resources on your behalf. For more information, see <a href="https://docs.aws.amazon.com/iot-sitewise/latest/userguide/monitor-service-role.html">Using service roles for IoT SiteWise Monitor</a> in the IoT SiteWise User Guide.

portalNamestringrequired

A new friendly name for the portal.

clientTokenstring

A unique case-sensitive identifier that you can provide to ensure the idempotency of the request. Don't reuse this client token if a new idempotent request is required.

portalLogoImageobject

Contains an image that is one of the following: <ul> <li> An image file. Choose this option to upload a new image. </li> <li> The ID of an existing image. Choose this option to keep an existing image. </li> </ul>

portalDescriptionstring

A new description for the portal.

portalContactEmailstringrequired

The Amazon Web Services administrator's contact email address.

notificationSenderEmailstring

The email address that sends alarm notifications.

Responses

{
  "success": true,
  "data": {
    "id": "abc123",
    "created_at": "2025-01-01T00:00:00Z"
  }
}

{
  "success": false,
  "error": {
    "code": "VALIDATION_ERROR",
    "message": "Invalid request parameters"
  }
}

Language

CredentialsAPI KEY

API Key

Enter token below to save for later

cURL Request

1curl --request PUT \
2     --url 'http://iotsitewise.{region}.amazonaws.com/portals/{portalId}' \
3     --header 'accept: application/json' \
4     --header 'content-type: application/json'

Response

1{
2  "success": true,
3  "data": {
4    "id": "abc123",
5    "created_at": "2025-01-01T00:00:00Z"
6  }
7}

PUT