You are viewing documentation for version 2 of the AWS SDK for Ruby. Version 3 documentation can be found here.

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

Inherits:
Struct
  • Object
show all
Defined in:
(unknown)

Overview

Returned by:

Instance Attribute Summary collapse

Instance Attribute Details

#portal_arn ⇒ String

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

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

Returns:

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

Possible values:

  • IAM
  • SSO

Returns:

  • (String) —

    The service to use to authenticate users to the portal.

#portal_client_id ⇒ String

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

Returns:

  • (String) —

    The AWS SSO application generated client ID (used with AWS SSO APIs).

#portal_contact_email ⇒ String

The AWS administrator\'s contact email address.

Returns:

  • (String) —

    The AWS administrator\'s contact email address.

#portal_creation_date ⇒ Time

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

Returns:

  • (Time) —

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

#portal_description ⇒ String

The portal\'s description.

Returns:

  • (String) —

    The portal\'s description.

#portal_id ⇒ String

The ID of the portal.

Returns:

  • (String) —

    The ID of the portal.

#portal_last_update_date ⇒ Time

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

Returns:

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

Returns:

#portal_name ⇒ String

The name of the portal.

Returns:

  • (String) —

    The name of the portal.

#portal_start_url ⇒ String

The URL for the AWS IoT SiteWise Monitor portal. You can use this URL to access portals that use AWS SSO for authentication. For portals that use IAM for authentication, you must use the CreatePresignedPortalUrl operation to create a URL that you can use to access the portal.

Returns:

  • (String) —

    The URL for the AWS IoT SiteWise Monitor portal.

#portal_status ⇒ Types::PortalStatus

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

Returns:

  • (Types::PortalStatus) —

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

#role_arn ⇒ String

The ARN of the service role that allows the portal\'s users to access your AWS IoT SiteWise resources on your behalf. For more information, see Using service roles for AWS IoT SiteWise Monitor in the AWS IoT SiteWise User Guide.

Returns:

  • (String) —

    The [ARN][1] of the service role that allows the portal\'s users to access your AWS IoT SiteWise resources on your behalf.