portal

Gets an individual portal resource

Overview

Name	portal
Type	Resource
Description	portal
Id	awscc.iotsitewise.portal

Fields

Name	Datatype	Description
portal_auth_mode	string	The service to use to authenticate users to the portal. Choose from SSO or IAM. You can't change this value after you create a portal.
portal_arn	string	The ARN of the portal, which has the following format.
portal_client_id	string	The AWS SSO application generated client ID (used with AWS SSO APIs).
portal_contact_email	string	The AWS administrator's contact email address.
portal_description	string	A description for the portal.
portal_id	string	The ID of the portal.
portal_name	string	A friendly name for the portal.
portal_start_url	string	The public root URL for the AWS IoT AWS IoT SiteWise Monitor application portal.
role_arn	string	The ARN of a service role that allows the portal's users to access your AWS IoT SiteWise resources on your behalf.
notification_sender_email	string	The email address that sends alarm notifications.
alarms	object	Contains the configuration information of an alarm created in an AWS 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.
tags	array	A list of key-value pairs that contain metadata for the portal.
region	string	AWS region.

Methods

Currently only SELECT is supported for this resource resource.

Example

SELECT
region,
portal_auth_mode,
portal_arn,
portal_client_id,
portal_contact_email,
portal_description,
portal_id,
portal_name,
portal_start_url,
role_arn,
notification_sender_email,
alarms,
tags
FROM awscc.iotsitewise.portal
WHERE data__Identifier = '<PortalId>';

Permissions

To operate on the portal resource, the following permissions are required:

Read

iotsitewise:DescribePortal,
iotsitewise:ListTagsForResource

Update

iotsitewise:DescribePortal,
iotsitewise:ListTagsForResource,
iotsitewise:TagResource,
iotsitewise:UpdatePortal,
iotsitewise:UntagResource,
iam:PassRole,
sso:GetManagedApplicationInstance,
sso:UpdateApplicationInstanceDisplayData

Delete

iotsitewise:DescribePortal,
iotsitewise:DeletePortal,
sso:DeleteManagedApplicationInstance