NAME
Paws::IoTSiteWise::DescribePortalResponse
ATTRIBUTES
Alarms => Paws::IoTSiteWise::Alarms
Contains the configuration information of an alarm created in a AWS IoT SiteWise Monitor portal.
NotificationSenderEmail => Str
The email address that sends alarm notifications.
REQUIRED PortalArn => Str
The ARN (https://docs.aws.amazon.com/general/latest/gr/aws-arns-and-namespaces.html) of the portal, which has the following format.
arn:${Partition}:iotsitewise:${Region}:${Account}:portal/${PortalId}
PortalAuthMode => Str
The service to use to authenticate users to the portal.
Valid values are: "IAM", "SSO" =head2 REQUIRED PortalClientId => Str
The AWS SSO application generated client ID (used with AWS SSO APIs). AWS IoT SiteWise includes portalClientId for only portals that use AWS SSO to authenticate users.
REQUIRED PortalContactEmail => Str
The AWS administrator's contact email address.
REQUIRED PortalCreationDate => Str
The date the portal was created, in Unix epoch time.
PortalDescription => Str
The portal's description.
REQUIRED PortalId => Str
The ID of the portal.
REQUIRED PortalLastUpdateDate => Str
The date the portal was last updated, in Unix epoch time.
PortalLogoImageLocation => Paws::IoTSiteWise::ImageLocation
The portal's logo image, which is available at a URL.
REQUIRED PortalName => Str
The name of the portal.
REQUIRED PortalStartUrl => Str
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.
REQUIRED PortalStatus => Paws::IoTSiteWise::PortalStatus
The current status of the portal, which contains a state and any error message.
RoleArn => Str
The ARN (https://docs.aws.amazon.com/general/latest/gr/aws-arns-and-namespaces.html) 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 (https://docs.aws.amazon.com/iot-sitewise/latest/userguide/monitor-service-role.html) in the AWS IoT SiteWise User Guide.