You are viewing documentation for version 2 of the AWS SDK for Ruby. Version 3 documentation can be found here.
Class: Aws::IoTSiteWise::Types::CreatePortalResponse
- Inherits:
-
Struct
- Object
- Struct
- Aws::IoTSiteWise::Types::CreatePortalResponse
- Defined in:
- (unknown)
Overview
Returned by:
Instance Attribute Summary collapse
-
#portal_arn ⇒ String
The [ARN][1] of the portal, which has the following format.
-
#portal_id ⇒ String
The ID of the created portal.
-
#portal_start_url ⇒ String
The URL for the AWS IoT SiteWise Monitor portal.
-
#portal_status ⇒ Types::PortalStatus
The status of the portal, which contains a state (
CREATING
after successfully calling this operation) and any error message. -
#sso_application_id ⇒ String
The associated AWS SSO application ID, if the portal uses AWS SSO.
Instance Attribute Details
#portal_arn ⇒ String
The ARN of the portal, which has the following format.
arn:$`{Partition}:iotsitewise:${Region}:${Account}:portal/${PortalId}`
#portal_id ⇒ String
The ID of the created 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.
#portal_status ⇒ Types::PortalStatus
The status of the portal, which contains a state (CREATING
after
successfully calling this operation) and any error message.
#sso_application_id ⇒ String
The associated AWS SSO application ID, if the portal uses AWS SSO.