You are viewing documentation for version 2 of the AWS SDK for Ruby. Version 3 documentation can be found here.

Class: Aws::IoTSiteWise::Types::PortalSummary

Inherits:
Struct
  • Object
show all
Defined in:
(unknown)

Overview

Contains a portal summary.

Instance Attribute Summary collapse

Instance Attribute Details

#creation_date ⇒ Time

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

Returns:

  • (Time) —

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

#description ⇒ String

The portal\'s description.

Returns:

  • (String) —

    The portal\'s description.

#id ⇒ String

The ID of the portal.

Returns:

  • (String) —

    The ID of the portal.

#last_update_date ⇒ Time

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

Returns:

  • (Time) —

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

#name ⇒ String

The name of the portal.

Returns:

  • (String) —

    The name of the portal.

#role_arn ⇒ String

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.

Returns:

  • (String) —

    The [ARN][1] of the service role that allows the portal\'s users to access your AWS IoT SiteWise resources on your behalf.

#start_url ⇒ String

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 CreatePresignedPortalUrl operation to create a URL that you can use to access the portal.

Returns:

  • (String) —

    The URL for the AWS IoT SiteWise Monitor portal.

#status ⇒ Types::PortalStatus

Contains information about the current status of a portal.

Returns: