v1

latestOpenAPI 3.0.0Apache 2.0 License2026-07-1473397365.8 KB

Updates an IoT SiteWise Monitor portal.

put/portals/{portalId}

Path parameters

portalIdstring required

The ID of the portal to update.

Request body

portalNamestring required

A new friendly name for the portal.

portalDescriptionstring

A new description for the portal.

portalContactEmailstring required

The Amazon Web Services administrator's contact email address.

roleArnstring required

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 <i>IoT SiteWise User Guide</i>.

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.

notificationSenderEmailstring

The email address that sends alarm notifications.

Response

Success