DescribePortalCommand

Suggest an Edit

Retrieves information about a portal.

Example Syntax

Use a bare-bones client and the command you need to make an API call.

import { IoTSiteWiseClient, DescribePortalCommand } from "@aws-sdk/client-iotsitewise"; // ES Modules import
// const { IoTSiteWiseClient, DescribePortalCommand } = require("@aws-sdk/client-iotsitewise"); // CommonJS import
const client = new IoTSiteWiseClient(config);
const input = { // DescribePortalRequest
  portalId: "STRING_VALUE", // required
};
const command = new DescribePortalCommand(input);
const response = await client.send(command);
// { // DescribePortalResponse
//   portalId: "STRING_VALUE", // required
//   portalArn: "STRING_VALUE", // required
//   portalName: "STRING_VALUE", // required
//   portalDescription: "STRING_VALUE",
//   portalClientId: "STRING_VALUE", // required
//   portalStartUrl: "STRING_VALUE", // required
//   portalContactEmail: "STRING_VALUE", // required
//   portalStatus: { // PortalStatus
//     state: "CREATING" || "PENDING" || "UPDATING" || "DELETING" || "ACTIVE" || "FAILED", // required
//     error: { // MonitorErrorDetails
//       code: "INTERNAL_FAILURE" || "VALIDATION_ERROR" || "LIMIT_EXCEEDED",
//       message: "STRING_VALUE",
//     },
//   },
//   portalCreationDate: new Date("TIMESTAMP"), // required
//   portalLastUpdateDate: new Date("TIMESTAMP"), // required
//   portalLogoImageLocation: { // ImageLocation
//     id: "STRING_VALUE", // required
//     url: "STRING_VALUE", // required
//   },
//   roleArn: "STRING_VALUE",
//   portalAuthMode: "IAM" || "SSO",
//   notificationSenderEmail: "STRING_VALUE",
//   alarms: { // Alarms
//     alarmRoleArn: "STRING_VALUE", // required
//     notificationLambdaArn: "STRING_VALUE",
//   },
//   portalType: "SITEWISE_PORTAL_V1" || "SITEWISE_PORTAL_V2",
//   portalTypeConfiguration: { // PortalTypeConfiguration
//     "<keys>": { // PortalTypeEntry
//       portalTools: [ // PortalTools
//         "STRING_VALUE",
//       ],
//     },
//   },
// };

DescribePortalCommand Input

See DescribePortalCommandInput for more details

Parameter
Type
Description
portalId
Required
string | undefined

The ID of the portal.

DescribePortalCommand Output

See DescribePortalCommandOutput for details

Parameter
Type
Description
$metadata
Required
ResponseMetadata
Metadata pertaining to this request.
portalArn
Required
string | undefined

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

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

portalClientId
Required
string | undefined

The IAM Identity Center application generated client ID (used with IAM Identity Center API operations). IoT SiteWise includes portalClientId for only portals that use IAM Identity Center to authenticate users.

portalContactEmail
Required
string | undefined

The Amazon Web Services administrator's contact email address.

portalCreationDate
Required
Date | undefined

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

portalId
Required
string | undefined

The ID of the portal.

portalLastUpdateDate
Required
Date | undefined

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

portalName
Required
string | undefined

The name of the portal.

portalStartUrl
Required
string | undefined

The URL for the IoT SiteWise Monitor portal. You can use this URL to access portals that use IAM Identity Center 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
Required
PortalStatus | undefined

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

alarms
Alarms | undefined

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

notificationSenderEmail
string | undefined

The email address that sends alarm notifications.

portalAuthMode
AuthMode | undefined

The service to use to authenticate users to the portal.

portalDescription
string | undefined

The portal's description.

portalLogoImageLocation
ImageLocation | undefined

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

portalType
PortalType | undefined

Define the type of portal. The value for IoT SiteWise Monitor (Classic) is SITEWISE_PORTAL_V1. The value for IoT SiteWise Monitor (AI-aware) is SITEWISE_PORTAL_V2.

portalTypeConfiguration
Record<string, PortalTypeEntry> | undefined

The configuration entry associated with the specific portal type. The value for IoT SiteWise Monitor (Classic) is SITEWISE_PORTAL_V1. The value for IoT SiteWise Monitor (AI-aware) is SITEWISE_PORTAL_V2.

roleArn
string | undefined

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.

Throws

Name
Fault
Details
InternalFailureException
server

IoT SiteWise can't process your request right now. Try again later.

InvalidRequestException
client

The request isn't valid. This can occur if your request contains malformed JSON or unsupported characters. Check your request and try again.

ResourceNotFoundException
client

The requested resource can't be found.

ThrottlingException
client

Your request exceeded a rate limit. For example, you might have exceeded the number of IoT SiteWise assets that can be created per second, the allowed number of messages per second, and so on.

For more information, see Quotas  in the IoT SiteWise User Guide.

IoTSiteWiseServiceException
Base exception class for all service exceptions from IoTSiteWise service.