PortalSummary

Contains a portal summary.

id

The ID of the portal.

Type: String

Length Constraints: Fixed length of 36.

Pattern: ^(?!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}$

Required: Yes

name

The name of the portal.

Type: String

Length Constraints: Minimum length of 1. Maximum length of 256.

Pattern: [^\u0000-\u001F\u007F]+

Required: Yes

startUrl

The URL for the AWS 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 AWS IoT SiteWise console to get a URL that you can use to access the portal.

Type: String

Length Constraints: Minimum length of 1. Maximum length of 256.

Pattern: ^(http|https)\://\S+

Required: Yes

status

Contains information about the current status of a portal.

Type: PortalStatus object

Required: Yes

creationDate

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

Type: Timestamp

Required: No

description

The portal's description.

Type: String

Length Constraints: Minimum length of 1. Maximum length of 2048.

Pattern: [^\u0000-\u001F\u007F]+

Required: No

lastUpdateDate

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

Type: Timestamp

Required: No

portalType

Define the type of portal. The value for AWS IoT SiteWise Monitor (Classic) is SITEWISE_PORTAL_V1. The value for AWS IoT SiteWise Monitor (AI-aware) is SITEWISE_PORTAL_V2.

Type: String

Valid Values: SITEWISE_PORTAL_V1 | SITEWISE_PORTAL_V2

Required: No

roleArn

The ARN of the service role that allows the portal's users to access your AWS IoT SiteWise resources on your behalf. For more information, see Using service roles for AWS IoT SiteWise Monitor in the AWS IoT SiteWise User Guide.

Type: String

Length Constraints: Minimum length of 1. Maximum length of 1600.

Pattern: ^arn:aws(-cn|-us-gov)?:[a-zA-Z0-9-:\/_\.\+=,@]+$

Required: No

PortalSummary

Contents

See Also