Amazon IoT SiteWise · Example Payload

Iot Sitewise Describe Portal Response Example

Asset ManagementIndustrial IoTIoTTime Series Data

Iot Sitewise Describe Portal Response Example is an example object payload from Amazon IoT SiteWise, with 15 top-level fields. It illustrates the shape of data this provider's APIs accept or return.

Top-level fields

portalIdportalArnportalNameportalDescriptionportalClientIdportalStartUrlportalContactEmailportalStatusportalCreationDateportalLastUpdateDateportalLogoImageLocationroleArnportalAuthModenotificationSenderEmailalarms

Example Payload

Raw ↑ 
{
  "portalId": "id-abc123",
  "portalArn": "arn:aws:iot:us-east-1:123456789012:thing/example",
  "portalName": "example-resource",
  "portalDescription": "example-value",
  "portalClientId": "id-abc123",
  "portalStartUrl": "https://example.com/path",
  "portalContactEmail": "example-value",
  "portalStatus": "ACTIVE",
  "portalCreationDate": "example-value",
  "portalLastUpdateDate": "example-value",
  "portalLogoImageLocation": "example-value",
  "roleArn": "arn:aws:iot:us-east-1:123456789012:thing/example",
  "portalAuthMode": "example-value",
  "notificationSenderEmail": "example-value",
  "alarms": "example-value"
}