PortalSummary - AWS IoT SiteWise

PortalSummary

Contains a portal summary.

Contents

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

id

The ID of the portal.

Type: String

Length Constraints: Fixed length of 36.

Pattern: ^[0-9a-f]{8}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{12}$

Required: Yes

lastUpdateDate

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

Type: Timestamp

Required: No

name

The name of the portal.

Type: String

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

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

Required: Yes

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: .*

Required: No

startUrl

The URL for the AWS IoT SiteWise Monitor portal. You can use this URL to access portals that use AWS SSO 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

See Also

For more information about using this API in one of the language-specific AWS SDKs, see the following: