Sign in

v1

latestOpenAPI 3.0.0Apache 2.0 License2026-07-1473397365.8 KB

Retrieves information about a portal.

get/portals/{portalId}

Path parameters

portalIdstring required

The ID of the portal.

Response

Success

portalIdstring required

The ID of the portal.

portalArnstring required
<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>
portalNamestring required

The name of the portal.

portalDescriptionstring

The portal's description.

portalClientIdstring required

The IAM Identity Center application generated client ID (used with IAM Identity Center APIs). IoT SiteWise includes <code>portalClientId</code> for only portals that use IAM Identity Center to authenticate users.

portalStartUrlstring required

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.

portalContactEmailstring required

The Amazon Web Services administrator's contact email address.

portalCreationDatestring date-time required

The date the portal was created, in Unix epoch time.

portalLastUpdateDatestring date-time required

The date the portal was last updated, in Unix epoch time.

roleArnstring

The <a href="https://docs.aws.amazon.com/general/latest/gr/aws-arns-and-namespaces.html">ARN</a> of the 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>.

portalAuthMode'IAM' | 'SSO'

The service to use to authenticate users to the portal.

notificationSenderEmailstring

The email address that sends alarm notifications.