portals

Creates, updates, deletes, gets or lists a portals resource.

Overview

Name	`portals`
Type	Resource
Id	`aws.iotsitewise.portals`

Fields

The following fields are returned by SELECT queries:

describe_portal
list_portals

Name	Datatype	Description
`alarms`	`object`	Contains the configuration information of an alarm created in an 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. For more information, see Monitoring with alarms in the IoT SiteWise Application Guide.
`notification_sender_email`	`string`	The email address that sends alarm notifications. (pattern: <code>^[a-zA-Z0-9_-.+]+@[a-zA-Z0-9_-.+]+.[a-zA-Z]{2,}$</code>)
`portal_arn`	`string`	The ARN of the portal, which has the following format. arn:${Partition}:iotsitewise:${Region}:${Account}:portal/${PortalId} (pattern: <code>^arn:aws(-cn\|-us-gov)?:[a-zA-Z0-9-:/_.]+$</code>)
`portal_auth_mode`	`string`	The service to use to authenticate users to the portal. (IAM, SSO)
`portal_client_id`	`string`	The IAM Identity Center application generated client ID (used with IAM Identity Center API operations). IoT SiteWise includes portalClientId for only portals that use IAM Identity Center to authenticate users. (pattern: <code>^[!-~]*</code>)
`portal_contact_email`	`string`	The Amazon Web Services administrator's contact email address. (pattern: <code>^[a-zA-Z0-9_-.+]+@[a-zA-Z0-9_-.+]+.[a-zA-Z]{2,}$</code>)
`portal_creation_date`	`string (date-time)`	The date the portal was created, in Unix epoch time.
`portal_description`	`string`	The portal's description. (pattern: <code>[^\u0000-\u001F\u007F]+</code>)
`portal_id`	`string`	The ID of the portal. (pattern: <code>^(?!00000000-0000-0000-0000-000000000000)[0-9a-f]{8}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{12}$</code>)
`portal_last_update_date`	`string (date-time)`	The date the portal was last updated, in Unix epoch time.
`portal_logo_image_location`	`object`	The portal's logo image, which is available at a URL.
`portal_name`	`string`	The name of the portal. (pattern: <code>[^\u0000-\u001F\u007F]+</code>)
`portal_start_url`	`string`	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. (pattern: <code>^(http\|https)://\S+</code>)
`portal_status`	`object`	Contains information about the current status of a portal.
`portal_type`	`string`	Define the type of portal. The value for IoT SiteWise Monitor (Classic) is SITEWISE_PORTAL_V1. The value for IoT SiteWise Monitor (AI-aware) is SITEWISE_PORTAL_V2. (SITEWISE_PORTAL_V1, SITEWISE_PORTAL_V2)
`portal_type_configuration`	`object`	The configuration entry associated with the specific portal type. The value for IoT SiteWise Monitor (Classic) is SITEWISE_PORTAL_V1. The value for IoT SiteWise Monitor (AI-aware) is SITEWISE_PORTAL_V2.
`role_arn`	`string`	The ARN of the service role that allows the portal's users to access your IoT SiteWise resources on your behalf. For more information, see Using service roles for IoT SiteWise Monitor in the IoT SiteWise User Guide. (pattern: <code>^arn:aws(-cn\|-us-gov)?:[a-zA-Z0-9-:/_.+=,@]+$</code>)

Name	Datatype	Description
`id`	`string`	The ID of the portal. (pattern: <code>^(?!00000000-0000-0000-0000-000000000000)[0-9a-f]{8}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{12}$</code>)
`name`	`string`	The name of the portal. (pattern: <code>[^\u0000-\u001F\u007F]+</code>)
`creation_date`	`string (date-time)`	The date the portal was created, in Unix epoch time.
`description`	`string`	The portal's description. (pattern: <code>[^\u0000-\u001F\u007F]+</code>)
`last_update_date`	`string (date-time)`	The date the portal was last updated, in Unix epoch time.
`portal_type`	`string`	Define the type of portal. The value for IoT SiteWise Monitor (Classic) is SITEWISE_PORTAL_V1. The value for IoT SiteWise Monitor (AI-aware) is SITEWISE_PORTAL_V2. (SITEWISE_PORTAL_V1, SITEWISE_PORTAL_V2)
`role_arn`	`string`	The ARN of the service role that allows the portal's users to access your IoT SiteWise resources on your behalf. For more information, see Using service roles for IoT SiteWise Monitor in the IoT SiteWise User Guide. (pattern: <code>^arn:aws(-cn\|-us-gov)?:[a-zA-Z0-9-:/_.+=,@]+$</code>)
`start_url`	`string`	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. (pattern: <code>^(http\|https)://\S+</code>)
`status`	`object`	Contains information about the current status of a portal.

Methods

The following methods are available for this resource:

Name	Accessible by	Required Params	Optional Params	Description
`describe_portal`	`select`	`portal_id`, `region`		Retrieves information about a portal.
`list_portals`	`select`	`region`	`nextToken`, `maxResults`	Retrieves a paginated list of IoT SiteWise Monitor portals.
`create_portal`	`insert`	`region`, `portalName`, `portalContactEmail`, `roleArn`		The IoT SiteWise Monitor feature will no longer be open to new customers starting November 7, 2025. If you would like to use the IoT SiteWise Monitor feature, sign up prior to that date. Existing customers can continue to use the service as normal. For more information, see IoT SiteWise Monitor availability change. Creates a portal, which can contain projects and dashboards. IoT SiteWise Monitor uses IAM Identity Center or IAM to authenticate portal users and manage user permissions. Before you can sign in to a new portal, you must add at least one identity to that portal. For more information, see Adding or removing portal administrators in the IoT SiteWise User Guide.
`update_portal`	`update`	`portal_id`, `region`, `portalName`, `portalContactEmail`, `roleArn`		The IoT SiteWise Monitor feature will no longer be open to new customers starting November 7, 2025. If you would like to use the IoT SiteWise Monitor feature, sign up prior to that date. Existing customers can continue to use the service as normal. For more information, see IoT SiteWise Monitor availability change. Updates an IoT SiteWise Monitor portal.
`delete_portal`	`delete`	`portal_id`, `region`	`clientToken`	Deletes a portal from IoT SiteWise Monitor.

Parameters

Parameters can be passed in the WHERE clause of a query. Check the Methods section to see which parameters are required or optional for each operation.

Name	Datatype	Description
`portal_id`	`string`	The ID of the portal to delete.
`region`	`string`	AWS region (default: us-east-1)
`clientToken`	`string`	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.
`maxResults`	`integer`	The maximum number of results to return for each paginated request. Default: 50
`nextToken`	`string`	The token to be used for the next set of paginated results.

`SELECT` examples

describe_portal
list_portals

Retrieves information about a portal.

SELECT
alarms,
notification_sender_email,
portal_arn,
portal_auth_mode,
portal_client_id,
portal_contact_email,
portal_creation_date,
portal_description,
portal_id,
portal_last_update_date,
portal_logo_image_location,
portal_name,
portal_start_url,
portal_status,
portal_type,
portal_type_configuration,
role_arn
FROM aws.iotsitewise.portals
WHERE portal_id = '{{ portal_id }}' -- required
AND region = '{{ region }}' -- required
;

Retrieves a paginated list of IoT SiteWise Monitor portals.

SELECT
id,
name,
creation_date,
description,
last_update_date,
portal_type,
role_arn,
start_url,
status
FROM aws.iotsitewise.portals
WHERE region = '{{ region }}' -- required
AND nextToken = '{{ nextToken }}'
AND maxResults = '{{ maxResults }}'
;

`INSERT` examples

create_portal
Manifest

The IoT SiteWise Monitor feature will no longer be open to new customers starting November 7, 2025. If you would like to use the IoT SiteWise Monitor feature, sign up prior to that date. Existing customers can continue to use the service as normal. For more information, see IoT SiteWise Monitor availability change. Creates a portal, which can contain projects and dashboards. IoT SiteWise Monitor uses IAM Identity Center or IAM to authenticate portal users and manage user permissions. Before you can sign in to a new portal, you must add at least one identity to that portal. For more information, see Adding or removing portal administrators in the IoT SiteWise User Guide.

INSERT INTO aws.iotsitewise.portals (
portalName,
portalDescription,
portalContactEmail,
clientToken,
portalLogoImageFile,
roleArn,
tags,
portalAuthMode,
notificationSenderEmail,
alarms,
portalType,
portalTypeConfiguration,
region
)
SELECT 
'{{ portalName }}' /* required */,
'{{ portalDescription }}',
'{{ portalContactEmail }}' /* required */,
'{{ clientToken }}',
'{{ portalLogoImageFile }}',
'{{ roleArn }}' /* required */,
'{{ tags }}',
'{{ portalAuthMode }}',
'{{ notificationSenderEmail }}',
'{{ alarms }}',
'{{ portalType }}',
'{{ portalTypeConfiguration }}',
'{{ region }}'
RETURNING
portal_arn,
portal_id,
portal_start_url,
portal_status,
sso_application_id
;

# Description fields are for documentation purposes
- name: portals
props:
  - name: region
    value: "{{ region }}"
    description: Required parameter for the portals resource.
  - name: portalName
    value: "{{ portalName }}"
  - name: portalDescription
    value: "{{ portalDescription }}"
  - name: portalContactEmail
    value: "{{ portalContactEmail }}"
  - name: clientToken
    value: "{{ clientToken }}"
  - name: portalLogoImageFile
    description: |
      Contains an image file.
    value:
      data: "{{ data }}"
      type_: "{{ type_ }}"
  - name: roleArn
    value: "{{ roleArn }}"
  - name: tags
    value: "{{ tags }}"
  - name: portalAuthMode
    value: "{{ portalAuthMode }}"
    valid_values: ['IAM', 'SSO']
  - name: notificationSenderEmail
    value: "{{ notificationSenderEmail }}"
  - name: alarms
    description: |
      Contains the configuration information of an alarm created in an 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. For more information, see Monitoring with alarms in the IoT SiteWise Application Guide.
    value:
      alarmRoleArn: "{{ alarmRoleArn }}"
      notificationLambdaArn: "{{ notificationLambdaArn }}"
  - name: portalType
    value: "{{ portalType }}"
    valid_values: ['SITEWISE_PORTAL_V1', 'SITEWISE_PORTAL_V2']
  - name: portalTypeConfiguration
    value: "{{ portalTypeConfiguration }}"

`UPDATE` examples

update_portal

UPDATE aws.iotsitewise.portals
SET 
portalName = '{{ portalName }}',
portalDescription = '{{ portalDescription }}',
portalContactEmail = '{{ portalContactEmail }}',
portalLogoImage = '{{ portalLogoImage }}',
roleArn = '{{ roleArn }}',
clientToken = '{{ clientToken }}',
notificationSenderEmail = '{{ notificationSenderEmail }}',
alarms = '{{ alarms }}',
portalType = '{{ portalType }}',
portalTypeConfiguration = '{{ portalTypeConfiguration }}'
WHERE 
portal_id = '{{ portal_id }}' --required
AND region = '{{ region }}' --required
AND portalName = '{{ portalName }}' --required
AND portalContactEmail = '{{ portalContactEmail }}' --required
AND roleArn = '{{ roleArn }}' --required
RETURNING
portal_status;

`DELETE` examples

delete_portal

Deletes a portal from IoT SiteWise Monitor.

DELETE FROM aws.iotsitewise.portals
WHERE portal_id = '{{ portal_id }}' --required
AND region = '{{ region }}' --required
AND clientToken = '{{ clientToken }}'
;

Overview​

Fields​

Methods​

Parameters​

SELECT examples​

INSERT examples​

UPDATE examples​

DELETE examples​