AWS services or capabilities described in AWS Documentation may vary by region/location. Click Getting Started with Amazon AWS to see specific differences applicable to the China (Beijing) Region.

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

Inherits:
Struct
  • Object
show all
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

Instance Attribute Details

#creation_dateTime

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

Returns:

  • (Time)


5182
5183
5184
5185
5186
5187
5188
5189
5190
5191
5192
5193
# File 'gems/aws-sdk-iotsitewise/lib/aws-sdk-iotsitewise/types.rb', line 5182

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

#descriptionString

The portal's description.

Returns:

  • (String)


5182
5183
5184
5185
5186
5187
5188
5189
5190
5191
5192
5193
# File 'gems/aws-sdk-iotsitewise/lib/aws-sdk-iotsitewise/types.rb', line 5182

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

#idString

The ID of the portal.

Returns:

  • (String)


5182
5183
5184
5185
5186
5187
5188
5189
5190
5191
5192
5193
# File 'gems/aws-sdk-iotsitewise/lib/aws-sdk-iotsitewise/types.rb', line 5182

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

#last_update_dateTime

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

Returns:

  • (Time)


5182
5183
5184
5185
5186
5187
5188
5189
5190
5191
5192
5193
# File 'gems/aws-sdk-iotsitewise/lib/aws-sdk-iotsitewise/types.rb', line 5182

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

#nameString

The name of the portal.

Returns:

  • (String)


5182
5183
5184
5185
5186
5187
5188
5189
5190
5191
5192
5193
# File 'gems/aws-sdk-iotsitewise/lib/aws-sdk-iotsitewise/types.rb', line 5182

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

#role_arnString

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.

Returns:

  • (String)


5182
5183
5184
5185
5186
5187
5188
5189
5190
5191
5192
5193
# File 'gems/aws-sdk-iotsitewise/lib/aws-sdk-iotsitewise/types.rb', line 5182

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

#start_urlString

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.

Returns:

  • (String)


5182
5183
5184
5185
5186
5187
5188
5189
5190
5191
5192
5193
# File 'gems/aws-sdk-iotsitewise/lib/aws-sdk-iotsitewise/types.rb', line 5182

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

#statusTypes::PortalStatus

Contains information about the current status of a portal.

Returns:



5182
5183
5184
5185
5186
5187
5188
5189
5190
5191
5192
5193
# File 'gems/aws-sdk-iotsitewise/lib/aws-sdk-iotsitewise/types.rb', line 5182

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