Request Syntax URI Request Parameters Request Body Response Syntax Response Elements Errors See Also

DescribePortal

Retrieves information about a portal.

Request Syntax


GET /portals/portalId HTTP/1.1

URI Request Parameters

The request uses the following URI parameters.

portalId

The ID of the portal.

Length Constraints: Fixed length of 36.

Pattern: ^[0-9a-f]{8}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{12}$

Required: Yes

Request Body

The request does not have a request body.

Response Syntax


HTTP/1.1 200
Content-type: application/json

{
   "alarms": { 
      "alarmRoleArn": "string",
      "notificationLambdaArn": "string"
   },
   "notificationSenderEmail": "string",
   "portalArn": "string",
   "portalAuthMode": "string",
   "portalClientId": "string",
   "portalContactEmail": "string",
   "portalCreationDate": number,
   "portalDescription": "string",
   "portalId": "string",
   "portalLastUpdateDate": number,
   "portalLogoImageLocation": { 
      "id": "string",
      "url": "string"
   },
   "portalName": "string",
   "portalStartUrl": "string",
   "portalStatus": { 
      "error": { 
         "code": "string",
         "message": "string"
      },
      "state": "string"
   },
   "roleArn": "string"
}

Response Elements

If the action is successful, the service sends back an HTTP 200 response.

The following data is returned in JSON format by the service.

alarms

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

Type: Alarms object

notificationSenderEmail

The email address that sends alarm notifications.

Type: String

Length Constraints: Minimum length of 1. Maximum length of 255.

Pattern: [^@]+@[^@]+

portalArn

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

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

Type: String

Length Constraints: Minimum length of 1. Maximum length of 1600.

Pattern: ^arn:aws(-cn|-us-gov)?:[a-zA-Z0-9-:\/_\.]+$

portalAuthMode

The service to use to authenticate users to the portal.

Type: String

Valid Values: IAM | SSO

portalClientId

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

Type: String

Length Constraints: Minimum length of 1. Maximum length of 256.

Pattern: ^[!-~]*

portalContactEmail

The AWS administrator's contact email address.

Type: String

Length Constraints: Minimum length of 1. Maximum length of 255.

Pattern: [^@]+@[^@]+

portalCreationDate

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

Type: Timestamp

portalDescription

The portal's description.

Type: String

Length Constraints: Minimum length of 1. Maximum length of 2048.

Pattern: [^\u0000-\u001F\u007F]+

portalId

The ID of the portal.

Type: String

Length Constraints: Fixed length of 36.

Pattern: ^[0-9a-f]{8}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{12}$

portalLastUpdateDate

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

Type: Timestamp

portalLogoImageLocation

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

Type: ImageLocation object

portalName

The name of the portal.

Type: String

Length Constraints: Minimum length of 1. Maximum length of 256.

Pattern: [^\u0000-\u001F\u007F]+

portalStartUrl

The URL for the AWS 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 AWS IoT SiteWise console to get a URL that you can use to access the portal.

Type: String

Length Constraints: Minimum length of 1. Maximum length of 256.

Pattern: ^(http|https)\://\S+

portalStatus

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

Type: PortalStatus object

roleArn

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.

Type: String

Length Constraints: Minimum length of 1. Maximum length of 1600.

Pattern: ^arn:aws(-cn|-us-gov)?:[a-zA-Z0-9-:\/_\.]+$

Errors

For information about the errors that are common to all actions, see Common Errors.

InternalFailureException

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

HTTP Status Code: 500

InvalidRequestException

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

HTTP Status Code: 400

ResourceNotFoundException

The requested resource can't be found.

HTTP Status Code: 404

ThrottlingException

Your request exceeded a rate limit. For example, you might have exceeded the number of AWS 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 AWS IoT SiteWise User Guide.

HTTP Status Code: 429