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::DescribePortalResponse

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

Constant Summary collapse

SENSITIVE =
[]

Instance Attribute Summary collapse

Instance Attribute Details

#alarmsTypes::Alarms

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

Returns:



3157
3158
3159
3160
3161
3162
3163
3164
3165
3166
3167
3168
3169
3170
3171
3172
3173
3174
3175
# File 'gems/aws-sdk-iotsitewise/lib/aws-sdk-iotsitewise/types.rb', line 3157

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_emailString

The email address that sends alarm notifications.

Returns:

  • (String)


3157
3158
3159
3160
3161
3162
3163
3164
3165
3166
3167
3168
3169
3170
3171
3172
3173
3174
3175
# File 'gems/aws-sdk-iotsitewise/lib/aws-sdk-iotsitewise/types.rb', line 3157

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_arnString

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

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

Returns:

  • (String)


3157
3158
3159
3160
3161
3162
3163
3164
3165
3166
3167
3168
3169
3170
3171
3172
3173
3174
3175
# File 'gems/aws-sdk-iotsitewise/lib/aws-sdk-iotsitewise/types.rb', line 3157

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_modeString

The service to use to authenticate users to the portal.

Returns:

  • (String)


3157
3158
3159
3160
3161
3162
3163
3164
3165
3166
3167
3168
3169
3170
3171
3172
3173
3174
3175
# File 'gems/aws-sdk-iotsitewise/lib/aws-sdk-iotsitewise/types.rb', line 3157

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_idString

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)


3157
3158
3159
3160
3161
3162
3163
3164
3165
3166
3167
3168
3169
3170
3171
3172
3173
3174
3175
# File 'gems/aws-sdk-iotsitewise/lib/aws-sdk-iotsitewise/types.rb', line 3157

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_emailString

The Amazon Web Services administrator's contact email address.

Returns:

  • (String)


3157
3158
3159
3160
3161
3162
3163
3164
3165
3166
3167
3168
3169
3170
3171
3172
3173
3174
3175
# File 'gems/aws-sdk-iotsitewise/lib/aws-sdk-iotsitewise/types.rb', line 3157

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_dateTime

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

Returns:

  • (Time)


3157
3158
3159
3160
3161
3162
3163
3164
3165
3166
3167
3168
3169
3170
3171
3172
3173
3174
3175
# File 'gems/aws-sdk-iotsitewise/lib/aws-sdk-iotsitewise/types.rb', line 3157

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_descriptionString

The portal's description.

Returns:

  • (String)


3157
3158
3159
3160
3161
3162
3163
3164
3165
3166
3167
3168
3169
3170
3171
3172
3173
3174
3175
# File 'gems/aws-sdk-iotsitewise/lib/aws-sdk-iotsitewise/types.rb', line 3157

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_idString

The ID of the portal.

Returns:

  • (String)


3157
3158
3159
3160
3161
3162
3163
3164
3165
3166
3167
3168
3169
3170
3171
3172
3173
3174
3175
# File 'gems/aws-sdk-iotsitewise/lib/aws-sdk-iotsitewise/types.rb', line 3157

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_dateTime

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

Returns:

  • (Time)


3157
3158
3159
3160
3161
3162
3163
3164
3165
3166
3167
3168
3169
3170
3171
3172
3173
3174
3175
# File 'gems/aws-sdk-iotsitewise/lib/aws-sdk-iotsitewise/types.rb', line 3157

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_locationTypes::ImageLocation

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



3157
3158
3159
3160
3161
3162
3163
3164
3165
3166
3167
3168
3169
3170
3171
3172
3173
3174
3175
# File 'gems/aws-sdk-iotsitewise/lib/aws-sdk-iotsitewise/types.rb', line 3157

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_nameString

The name of the portal.

Returns:

  • (String)


3157
3158
3159
3160
3161
3162
3163
3164
3165
3166
3167
3168
3169
3170
3171
3172
3173
3174
3175
# File 'gems/aws-sdk-iotsitewise/lib/aws-sdk-iotsitewise/types.rb', line 3157

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_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)


3157
3158
3159
3160
3161
3162
3163
3164
3165
3166
3167
3168
3169
3170
3171
3172
3173
3174
3175
# File 'gems/aws-sdk-iotsitewise/lib/aws-sdk-iotsitewise/types.rb', line 3157

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_statusTypes::PortalStatus

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

Returns:



3157
3158
3159
3160
3161
3162
3163
3164
3165
3166
3167
3168
3169
3170
3171
3172
3173
3174
3175
# File 'gems/aws-sdk-iotsitewise/lib/aws-sdk-iotsitewise/types.rb', line 3157

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_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)


3157
3158
3159
3160
3161
3162
3163
3164
3165
3166
3167
3168
3169
3170
3171
3172
3173
3174
3175
# File 'gems/aws-sdk-iotsitewise/lib/aws-sdk-iotsitewise/types.rb', line 3157

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