portals_list_only

Lists portals in a region or regions, for all properties use portals

Overview

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

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.

Name	Accessible by	Required Params
`list_resources`	`SELECT`	`region`

Lists all portals in a region.

SELECT
region,
portal_id
FROM aws.iotsitewise.portals_list_only
WHERE region = 'us-east-1';

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