Class: Aws::IoTSiteWise::Types::PortalSummary
- Inherits:
-
Struct
- Object
- Struct
- Aws::IoTSiteWise::Types::PortalSummary
- Defined in:
- gems/aws-sdk-iotsitewise/lib/aws-sdk-iotsitewise/types.rb
Overview
Contains a portal summary.
Constant Summary collapse
- SENSITIVE =
[]
Instance Attribute Summary collapse
-
#creation_date ⇒ Time
The date the portal was created, in Unix epoch time.
-
#description ⇒ String
The portal's description.
-
#id ⇒ String
The ID of the portal.
-
#last_update_date ⇒ Time
The date the portal was last updated, in Unix epoch time.
-
#name ⇒ String
The name of the portal.
-
#role_arn ⇒ String
The [ARN][1] of the service role that allows the portal's users to access your IoT SiteWise resources on your behalf.
-
#start_url ⇒ String
The URL for the IoT SiteWise Monitor portal.
-
#status ⇒ Types::PortalStatus
Contains information about the current status of a portal.
Instance Attribute Details
#creation_date ⇒ Time
The date the portal was created, in Unix epoch time.
7183 7184 7185 7186 7187 7188 7189 7190 7191 7192 7193 7194 |
# File 'gems/aws-sdk-iotsitewise/lib/aws-sdk-iotsitewise/types.rb', line 7183 class PortalSummary < Struct.new( :id, :name, :description, :start_url, :creation_date, :last_update_date, :role_arn, :status) SENSITIVE = [] include Aws::Structure end |
#description ⇒ String
The portal's description.
7183 7184 7185 7186 7187 7188 7189 7190 7191 7192 7193 7194 |
# File 'gems/aws-sdk-iotsitewise/lib/aws-sdk-iotsitewise/types.rb', line 7183 class PortalSummary < Struct.new( :id, :name, :description, :start_url, :creation_date, :last_update_date, :role_arn, :status) SENSITIVE = [] include Aws::Structure end |
#id ⇒ String
The ID of the portal.
7183 7184 7185 7186 7187 7188 7189 7190 7191 7192 7193 7194 |
# File 'gems/aws-sdk-iotsitewise/lib/aws-sdk-iotsitewise/types.rb', line 7183 class PortalSummary < Struct.new( :id, :name, :description, :start_url, :creation_date, :last_update_date, :role_arn, :status) SENSITIVE = [] include Aws::Structure end |
#last_update_date ⇒ Time
The date the portal was last updated, in Unix epoch time.
7183 7184 7185 7186 7187 7188 7189 7190 7191 7192 7193 7194 |
# File 'gems/aws-sdk-iotsitewise/lib/aws-sdk-iotsitewise/types.rb', line 7183 class PortalSummary < Struct.new( :id, :name, :description, :start_url, :creation_date, :last_update_date, :role_arn, :status) SENSITIVE = [] include Aws::Structure end |
#name ⇒ String
The name of the portal.
7183 7184 7185 7186 7187 7188 7189 7190 7191 7192 7193 7194 |
# File 'gems/aws-sdk-iotsitewise/lib/aws-sdk-iotsitewise/types.rb', line 7183 class PortalSummary < Struct.new( :id, :name, :description, :start_url, :creation_date, :last_update_date, :role_arn, :status) SENSITIVE = [] include Aws::Structure end |
#role_arn ⇒ String
The ARN 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 in the IoT SiteWise User Guide.
7183 7184 7185 7186 7187 7188 7189 7190 7191 7192 7193 7194 |
# File 'gems/aws-sdk-iotsitewise/lib/aws-sdk-iotsitewise/types.rb', line 7183 class PortalSummary < Struct.new( :id, :name, :description, :start_url, :creation_date, :last_update_date, :role_arn, :status) SENSITIVE = [] include Aws::Structure end |
#start_url ⇒ String
The URL for the 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 IoT SiteWise console to get a URL that you can use to access the portal.
7183 7184 7185 7186 7187 7188 7189 7190 7191 7192 7193 7194 |
# File 'gems/aws-sdk-iotsitewise/lib/aws-sdk-iotsitewise/types.rb', line 7183 class PortalSummary < Struct.new( :id, :name, :description, :start_url, :creation_date, :last_update_date, :role_arn, :status) SENSITIVE = [] include Aws::Structure end |
#status ⇒ Types::PortalStatus
Contains information about the current status of a portal.
7183 7184 7185 7186 7187 7188 7189 7190 7191 7192 7193 7194 |
# File 'gems/aws-sdk-iotsitewise/lib/aws-sdk-iotsitewise/types.rb', line 7183 class PortalSummary < Struct.new( :id, :name, :description, :start_url, :creation_date, :last_update_date, :role_arn, :status) SENSITIVE = [] include Aws::Structure end |