class Aws::IoTSiteWise::Types::DescribePortalResponse
@!attribute [rw] portal_id
The ID of the portal. @return [String]
@!attribute [rw] portal_arn
The [ARN][1] of the portal, which has the following format. `arn:$\{Partition\}:iotsitewise:$\{Region\}:$\{Account\}:portal/$\{PortalId\}` [1]: https://docs.aws.amazon.com/general/latest/gr/aws-arns-and-namespaces.html @return [String]
@!attribute [rw] portal_name
The name of the portal. @return [String]
@!attribute [rw] portal_description
The portal's description. @return [String]
@!attribute [rw] portal_client_id
The Amazon Web Services SSO application generated client ID (used with Amazon Web Services SSO APIs). IoT SiteWise includes `portalClientId` for only portals that use Amazon Web Services SSO to authenticate users. @return [String]
@!attribute [rw] portal_start_url
The URL for the IoT SiteWise Monitor portal. You can use this URL to access portals that use Amazon Web Services SSO 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. @return [String]
@!attribute [rw] portal_contact_email
The Amazon Web Services administrator's contact email address. @return [String]
@!attribute [rw] portal_status
The current status of the portal, which contains a state and any error message. @return [Types::PortalStatus]
@!attribute [rw] portal_creation_date
The date the portal was created, in Unix epoch time. @return [Time]
@!attribute [rw] portal_last_update_date
The date the portal was last updated, in Unix epoch time. @return [Time]
@!attribute [rw] portal_logo_image_location
The portal's logo image, which is available at a URL. @return [Types::ImageLocation]
@!attribute [rw] role_arn
The [ARN][1] 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][2] in the *IoT SiteWise User Guide*. [1]: https://docs.aws.amazon.com/general/latest/gr/aws-arns-and-namespaces.html [2]: https://docs.aws.amazon.com/iot-sitewise/latest/userguide/monitor-service-role.html @return [String]
@!attribute [rw] portal_auth_mode
The service to use to authenticate users to the portal. @return [String]
@!attribute [rw] notification_sender_email
The email address that sends alarm notifications. @return [String]
@!attribute [rw] alarms
Contains the configuration information of an alarm created in an IoT SiteWise Monitor portal. @return [Types::Alarms]
Constants
- SENSITIVE