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

Inherits:
Struct
  • Object
show all
Includes:
Structure
Defined in:
lib/aws-sdk-iotsitewise/types.rb

Overview

Contains a portal summary.

Constant Summary collapse

SENSITIVE = 
[]

Instance Attribute Summary collapse

Instance Attribute Details

#creation_date ⇒ Time

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

Returns:

  • (Time) 


7354
7355
7356
7357
7358
7359
7360
7361
7362
7363
7364
7365
 
# File 'lib/aws-sdk-iotsitewise/types.rb', line 7354

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.

Returns:

  • (String) 


7354
7355
7356
7357
7358
7359
7360
7361
7362
7363
7364
7365
 
# File 'lib/aws-sdk-iotsitewise/types.rb', line 7354

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.

Returns:

  • (String) 


7354
7355
7356
7357
7358
7359
7360
7361
7362
7363
7364
7365
 
# File 'lib/aws-sdk-iotsitewise/types.rb', line 7354

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.

Returns:

  • (Time) 


7354
7355
7356
7357
7358
7359
7360
7361
7362
7363
7364
7365
 
# File 'lib/aws-sdk-iotsitewise/types.rb', line 7354

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.

Returns:

  • (String) 


7354
7355
7356
7357
7358
7359
7360
7361
7362
7363
7364
7365
 
# File 'lib/aws-sdk-iotsitewise/types.rb', line 7354

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

[1]: docs.aws.amazon.com/general/latest/gr/aws-arns-and-namespaces.html [2]: docs.aws.amazon.com/iot-sitewise/latest/userguide/monitor-service-role.html

Returns:

  • (String) 


7354
7355
7356
7357
7358
7359
7360
7361
7362
7363
7364
7365
 
# File 'lib/aws-sdk-iotsitewise/types.rb', line 7354

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.

Returns:

  • (String) 


7354
7355
7356
7357
7358
7359
7360
7361
7362
7363
7364
7365
 
# File 'lib/aws-sdk-iotsitewise/types.rb', line 7354

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.

Returns:



7354
7355
7356
7357
7358
7359
7360
7361
7362
7363
7364
7365
 
# File 'lib/aws-sdk-iotsitewise/types.rb', line 7354

class PortalSummary < Struct.new(
  :id,
  :name,
  :description,
  :start_url,
  :creation_date,
  :last_update_date,
  :role_arn,
  :status)
  SENSITIVE = []
  include Aws::Structure
end