DescribePortalResponse

public struct DescribePortalResponse : AWSShape

Undocumented

  • Declaration

    Swift

    public static var _members: [AWSShapeMember]

  • The ARN of the portal, which has the following format. arn:${Partition}:iotsitewise:${Region}:${Account}:portal/${PortalId}

    Declaration

    Swift

    public let portalArn: String

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

    Declaration

    Swift

    public let portalClientId: String

  • The AWS administrator’s contact email address.

    Declaration

    Swift

    public let portalContactEmail: String

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

    Declaration

    Swift

    public let portalCreationDate: TimeStamp

  • The portal’s description.

    Declaration

    Swift

    public let portalDescription: String?

  • The ID of the portal.

    Declaration

    Swift

    public let portalId: String

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

    Declaration

    Swift

    public let portalLastUpdateDate: TimeStamp

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

    Declaration

    Swift

    public let portalLogoImageLocation: ImageLocation?

  • The name of the portal.

    Declaration

    Swift

    public let portalName: String

  • The public root URL for the AWS IoT AWS IoT SiteWise Monitor application portal.

    Declaration

    Swift

    public let portalStartUrl: String

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

    Declaration

    Swift

    public let portalStatus: PortalStatus

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

    Declaration

    Swift

    public let roleArn: String?

  • Undocumented

    Declaration

    Swift

    public init(portalArn: String, portalClientId: String, portalContactEmail: String, portalCreationDate: TimeStamp, portalDescription: String? = nil, portalId: String, portalLastUpdateDate: TimeStamp, portalLogoImageLocation: ImageLocation? = nil, portalName: String, portalStartUrl: String, portalStatus: PortalStatus, roleArn: String? = nil)