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

Inherits:

Struct

• Object
• Struct
• Aws::IoTSiteWise::Types::PortalSummary

Includes:

Structure

Defined in:

lib/aws-sdk-iotsitewise/types.rb

Overview

Contains a portal summary.

Constant Summary

SENSITIVE =

[]

Instance Attribute Summary

• #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.

• #portal_type ⇒ String

  Define the type of portal.

• #role_arn ⇒ String

  The [ARN] 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.

Returns:

• (Time)

# File 'lib/aws-sdk-iotsitewise/types.rb', line 7888

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

#description ⇒ String

The portal’s description.

Returns:

• (String)

# File 'lib/aws-sdk-iotsitewise/types.rb', line 7888

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

#id ⇒ String

The ID of the portal.

Returns:

• (String)

# File 'lib/aws-sdk-iotsitewise/types.rb', line 7888

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

#last_update_date ⇒ Time

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

Returns:

• (Time)

# File 'lib/aws-sdk-iotsitewise/types.rb', line 7888

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

#name ⇒ String

The name of the portal.

Returns:

• (String)

# File 'lib/aws-sdk-iotsitewise/types.rb', line 7888

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

#portal_type ⇒ String

Define the type of portal. The value for IoT SiteWise Monitor (Classic) is ‘SITEWISE_PORTAL_V1`. The value for IoT SiteWise Monitor (AI-aware) is `SITEWISE_PORTAL_V2`.

Returns:

• (String)

# File 'lib/aws-sdk-iotsitewise/types.rb', line 7888

class PortalSummary < Struct.new(
  :id,
  :name,
  :description,
  :start_url,
  :creation_date,
  :last_update_date,
  :role_arn,
  :status,
  :portal_type)
  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)

# File 'lib/aws-sdk-iotsitewise/types.rb', line 7888

class PortalSummary < Struct.new(
  :id,
  :name,
  :description,
  :start_url,
  :creation_date,
  :last_update_date,
  :role_arn,
  :status,
  :portal_type)
  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)

# File 'lib/aws-sdk-iotsitewise/types.rb', line 7888

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

#status ⇒ Types::PortalStatus

Contains information about the current status of a portal.

Returns:

• (Types::PortalStatus)

# File 'lib/aws-sdk-iotsitewise/types.rb', line 7888

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