UpdatePortalRequest

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

interface UpdatePortalRequest {

alarms?: Alarms | null;

clientToken?: string | null;

notificationSenderEmail?: string | null;

portalContactEmail: string;

portalDescription?: string | null;

portalId: string;

portalLogoImage?: Image | null;

portalName: string;

roleArn: string;

}

§Properties

alarms?: Alarms | null

[src]

Contains the configuration information of an alarm created in an IoT SiteWise Monitor portal. You can use the alarm to monitor an asset property and get notified when the asset property value is outside a specified range. For more information, see Monitoring with alarms in the IoT SiteWise Application Guide.

clientToken?: string | null

[src]

A unique case-sensitive identifier that you can provide to ensure the idempotency of the request. Don't reuse this client token if a new idempotent request is required.

notificationSenderEmail?: string | null

[src]

The email address that sends alarm notifications.

portalContactEmail: string

[src]

The Amazon Web Services administrator's contact email address.

portalDescription?: string | null

[src]

A new description for the portal.

portalId: string

[src]

The ID of the portal to update.

portalLogoImage?: Image | null

[src]

portalName: string

[src]

A new friendly name for the portal.

roleArn: string

[src]

The ARN of a 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.