Class: Aws::IoTSiteWise::Types::DescribePortalResponse

Inherits:

Struct

Object
Struct
Aws::IoTSiteWise::Types::DescribePortalResponse

show all

Defined in:: gems/aws-sdk-iotsitewise/lib/aws-sdk-iotsitewise/types.rb

Constant Summary collapse

SENSITIVE =

[]

Instance Attribute Summary collapse

#alarms ⇒ Types::Alarms
Contains the configuration information of an alarm created in an IoT SiteWise Monitor portal.
#notification_sender_email ⇒ String
The email address that sends alarm notifications.
#portal_arn ⇒ String
The [ARN][1] of the portal, which has the following format.
#portal_auth_mode ⇒ String
The service to use to authenticate users to the portal.
#portal_client_id ⇒ String
The Amazon Web Services SSO application generated client ID (used with Amazon Web Services SSO APIs).
#portal_contact_email ⇒ String
The Amazon Web Services administrator's contact email address.
#portal_creation_date ⇒ Time
The date the portal was created, in Unix epoch time.
#portal_description ⇒ String
The portal's description.
#portal_id ⇒ String
The ID of the portal.
#portal_last_update_date ⇒ Time
The date the portal was last updated, in Unix epoch time.
#portal_logo_image_location ⇒ Types::ImageLocation
The portal's logo image, which is available at a URL.
#portal_name ⇒ String
The name of the portal.
#portal_start_url ⇒ String
The URL for the IoT SiteWise Monitor portal.
#portal_status ⇒ Types::PortalStatus
The current status of the portal, which contains a state and any error message.
#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.

Instance Attribute Details

#alarms ⇒ `Types::Alarms`

Contains the configuration information of an alarm created in an IoT SiteWise Monitor portal.

Returns:

(Types::Alarms)

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

class DescribePortalResponse < Struct.new(
  :portal_id,
  :portal_arn,
  :portal_name,
  :portal_description,
  :portal_client_id,
  :portal_start_url,
  :portal_contact_email,
  :portal_status,
  :portal_creation_date,
  :portal_last_update_date,
  :portal_logo_image_location,
  :role_arn,
  :portal_auth_mode,
  :notification_sender_email,
  :alarms)
  SENSITIVE = []
  include Aws::Structure
end

#notification_sender_email ⇒ `String`

The email address that sends alarm notifications.

Returns:

(String)

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

class DescribePortalResponse < Struct.new(
  :portal_id,
  :portal_arn,
  :portal_name,
  :portal_description,
  :portal_client_id,
  :portal_start_url,
  :portal_contact_email,
  :portal_status,
  :portal_creation_date,
  :portal_last_update_date,
  :portal_logo_image_location,
  :role_arn,
  :portal_auth_mode,
  :notification_sender_email,
  :alarms)
  SENSITIVE = []
  include Aws::Structure
end

#portal_arn ⇒ `String`

The ARN of the portal, which has the following format.

arn:$\{Partition\}:iotsitewise:$\{Region\}:$\{Account\}:portal/$\{PortalId\}

Returns:

(String)

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

class DescribePortalResponse < Struct.new(
  :portal_id,
  :portal_arn,
  :portal_name,
  :portal_description,
  :portal_client_id,
  :portal_start_url,
  :portal_contact_email,
  :portal_status,
  :portal_creation_date,
  :portal_last_update_date,
  :portal_logo_image_location,
  :role_arn,
  :portal_auth_mode,
  :notification_sender_email,
  :alarms)
  SENSITIVE = []
  include Aws::Structure
end

#portal_auth_mode ⇒ `String`

The service to use to authenticate users to the portal.

Returns:

(String)

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

class DescribePortalResponse < Struct.new(
  :portal_id,
  :portal_arn,
  :portal_name,
  :portal_description,
  :portal_client_id,
  :portal_start_url,
  :portal_contact_email,
  :portal_status,
  :portal_creation_date,
  :portal_last_update_date,
  :portal_logo_image_location,
  :role_arn,
  :portal_auth_mode,
  :notification_sender_email,
  :alarms)
  SENSITIVE = []
  include Aws::Structure
end

#portal_client_id ⇒ `String`

The Amazon Web Services SSO application generated client ID (used with Amazon Web Services SSO APIs). IoT SiteWise includes portalClientId for only portals that use Amazon Web Services SSO to authenticate users.

Returns:

(String)

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

class DescribePortalResponse < Struct.new(
  :portal_id,
  :portal_arn,
  :portal_name,
  :portal_description,
  :portal_client_id,
  :portal_start_url,
  :portal_contact_email,
  :portal_status,
  :portal_creation_date,
  :portal_last_update_date,
  :portal_logo_image_location,
  :role_arn,
  :portal_auth_mode,
  :notification_sender_email,
  :alarms)
  SENSITIVE = []
  include Aws::Structure
end

#portal_contact_email ⇒ `String`

The Amazon Web Services administrator's contact email address.

Returns:

(String)

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

class DescribePortalResponse < Struct.new(
  :portal_id,
  :portal_arn,
  :portal_name,
  :portal_description,
  :portal_client_id,
  :portal_start_url,
  :portal_contact_email,
  :portal_status,
  :portal_creation_date,
  :portal_last_update_date,
  :portal_logo_image_location,
  :role_arn,
  :portal_auth_mode,
  :notification_sender_email,
  :alarms)
  SENSITIVE = []
  include Aws::Structure
end

#portal_creation_date ⇒ `Time`

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

Returns:

(Time)

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

class DescribePortalResponse < Struct.new(
  :portal_id,
  :portal_arn,
  :portal_name,
  :portal_description,
  :portal_client_id,
  :portal_start_url,
  :portal_contact_email,
  :portal_status,
  :portal_creation_date,
  :portal_last_update_date,
  :portal_logo_image_location,
  :role_arn,
  :portal_auth_mode,
  :notification_sender_email,
  :alarms)
  SENSITIVE = []
  include Aws::Structure
end

#portal_description ⇒ `String`

The portal's description.

Returns:

(String)

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

class DescribePortalResponse < Struct.new(
  :portal_id,
  :portal_arn,
  :portal_name,
  :portal_description,
  :portal_client_id,
  :portal_start_url,
  :portal_contact_email,
  :portal_status,
  :portal_creation_date,
  :portal_last_update_date,
  :portal_logo_image_location,
  :role_arn,
  :portal_auth_mode,
  :notification_sender_email,
  :alarms)
  SENSITIVE = []
  include Aws::Structure
end

#portal_id ⇒ `String`

The ID of the portal.

Returns:

(String)

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

class DescribePortalResponse < Struct.new(
  :portal_id,
  :portal_arn,
  :portal_name,
  :portal_description,
  :portal_client_id,
  :portal_start_url,
  :portal_contact_email,
  :portal_status,
  :portal_creation_date,
  :portal_last_update_date,
  :portal_logo_image_location,
  :role_arn,
  :portal_auth_mode,
  :notification_sender_email,
  :alarms)
  SENSITIVE = []
  include Aws::Structure
end

#portal_last_update_date ⇒ `Time`

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

Returns:

(Time)

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

class DescribePortalResponse < Struct.new(
  :portal_id,
  :portal_arn,
  :portal_name,
  :portal_description,
  :portal_client_id,
  :portal_start_url,
  :portal_contact_email,
  :portal_status,
  :portal_creation_date,
  :portal_last_update_date,
  :portal_logo_image_location,
  :role_arn,
  :portal_auth_mode,
  :notification_sender_email,
  :alarms)
  SENSITIVE = []
  include Aws::Structure
end

#portal_logo_image_location ⇒ `Types::ImageLocation`

The portal's logo image, which is available at a URL.

Returns:

(Types::ImageLocation)

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

class DescribePortalResponse < Struct.new(
  :portal_id,
  :portal_arn,
  :portal_name,
  :portal_description,
  :portal_client_id,
  :portal_start_url,
  :portal_contact_email,
  :portal_status,
  :portal_creation_date,
  :portal_last_update_date,
  :portal_logo_image_location,
  :role_arn,
  :portal_auth_mode,
  :notification_sender_email,
  :alarms)
  SENSITIVE = []
  include Aws::Structure
end

#portal_name ⇒ `String`

The name of the portal.

Returns:

(String)

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

class DescribePortalResponse < Struct.new(
  :portal_id,
  :portal_arn,
  :portal_name,
  :portal_description,
  :portal_client_id,
  :portal_start_url,
  :portal_contact_email,
  :portal_status,
  :portal_creation_date,
  :portal_last_update_date,
  :portal_logo_image_location,
  :role_arn,
  :portal_auth_mode,
  :notification_sender_email,
  :alarms)
  SENSITIVE = []
  include Aws::Structure
end

#portal_start_url ⇒ `String`

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)

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

class DescribePortalResponse < Struct.new(
  :portal_id,
  :portal_arn,
  :portal_name,
  :portal_description,
  :portal_client_id,
  :portal_start_url,
  :portal_contact_email,
  :portal_status,
  :portal_creation_date,
  :portal_last_update_date,
  :portal_logo_image_location,
  :role_arn,
  :portal_auth_mode,
  :notification_sender_email,
  :alarms)
  SENSITIVE = []
  include Aws::Structure
end

#portal_status ⇒ `Types::PortalStatus`

The current status of the portal, which contains a state and any error message.

Returns:

(Types::PortalStatus)

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

class DescribePortalResponse < Struct.new(
  :portal_id,
  :portal_arn,
  :portal_name,
  :portal_description,
  :portal_client_id,
  :portal_start_url,
  :portal_contact_email,
  :portal_status,
  :portal_creation_date,
  :portal_last_update_date,
  :portal_logo_image_location,
  :role_arn,
  :portal_auth_mode,
  :notification_sender_email,
  :alarms)
  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.

Returns:

(String)

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

class DescribePortalResponse < Struct.new(
  :portal_id,
  :portal_arn,
  :portal_name,
  :portal_description,
  :portal_client_id,
  :portal_start_url,
  :portal_contact_email,
  :portal_status,
  :portal_creation_date,
  :portal_last_update_date,
  :portal_logo_image_location,
  :role_arn,
  :portal_auth_mode,
  :notification_sender_email,
  :alarms)
  SENSITIVE = []
  include Aws::Structure
end

Class: Aws::IoTSiteWise::Types::DescribePortalResponse

Constant Summary collapse

Instance Attribute Summary collapse

Instance Attribute Details

#alarms ⇒ Types::Alarms

#notification_sender_email ⇒ String

#portal_arn ⇒ String

#portal_auth_mode ⇒ String

#portal_client_id ⇒ String

#portal_contact_email ⇒ String

#portal_creation_date ⇒ Time

#portal_description ⇒ String

#portal_id ⇒ String

#portal_last_update_date ⇒ Time

#portal_logo_image_location ⇒ Types::ImageLocation

#portal_name ⇒ String

#portal_start_url ⇒ String

#portal_status ⇒ Types::PortalStatus

#role_arn ⇒ String

#alarms ⇒ `Types::Alarms`

#notification_sender_email ⇒ `String`

#portal_arn ⇒ `String`

#portal_auth_mode ⇒ `String`

#portal_client_id ⇒ `String`

#portal_contact_email ⇒ `String`

#portal_creation_date ⇒ `Time`

#portal_description ⇒ `String`

#portal_id ⇒ `String`

#portal_last_update_date ⇒ `Time`

#portal_logo_image_location ⇒ `Types::ImageLocation`

#portal_name ⇒ `String`

#portal_start_url ⇒ `String`

#portal_status ⇒ `Types::PortalStatus`

#role_arn ⇒ `String`