DescribePortalResponse

import type { DescribePortalResponse } from "https://aws-api.deno.dev/v0.3/services/iotsitewise.ts?docs=full";

interface DescribePortalResponse {

alarms?: Alarms | null;

notificationSenderEmail?: string | null;

portalArn: string;

portalAuthMode?: AuthMode | null;

portalClientId: string;

portalContactEmail: string;

portalCreationDate: Date | number;

portalDescription?: string | null;

portalId: string;

portalLastUpdateDate: Date | number;

portalLogoImageLocation?: ImageLocation | null;

portalName: string;

portalStartUrl: string;

portalStatus: PortalStatus;

roleArn?: string | null;

}

§Properties

alarms?: Alarms | null

[src]

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

notificationSenderEmail?: string | null

[src]

The email address that sends alarm notifications.

portalArn: string

[src]

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

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

portalAuthMode?: AuthMode | null

[src]

The service to use to authenticate users to the portal.

portalClientId: string

[src]

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.

portalContactEmail: string

[src]

The Amazon Web Services administrator's contact email address.

portalCreationDate: Date | number

[src]

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

portalDescription?: string | null

[src]

The portal's description.

portalId: string

[src]

The ID of the portal.

portalLastUpdateDate: Date | number

[src]

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

portalLogoImageLocation?: ImageLocation | null

[src]

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

portalName: string

[src]

The name of the portal.

portalStartUrl: string

[src]

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.

portalStatus: PortalStatus

[src]

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

roleArn?: string | null

[src]

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.