portal_tags

Expands all tag keys and values for portals in a region

Overview

Name	portal_tags
Type	Resource
Description	Resource schema for AWS::IoTSiteWise::Portal
Id	aws.iotsitewise.portal_tags

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.
tag_key	string	Tag key.
tag_value	string	Tag value.
region	string	AWS region.

Methods

Name	Accessible by	Required Params
list_resources	SELECT	region

SELECT examples

Expands tags for all portals in a region.

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,
tag_key,
tag_value
FROM aws.iotsitewise.portal_tags
WHERE region = 'us-east-1';

Permissions

For permissions required to operate on the portal_tags resource, see portals