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

UpdatePortal

Updates an AWS IoT SiteWise Monitor portal.

Request Syntax


PUT /portals/portalId HTTP/1.1
Content-type: application/json

{
   "alarms": { 
      "alarmRoleArn": "string",
      "notificationLambdaArn": "string"
   },
   "clientToken": "string",
   "notificationSenderEmail": "string",
   "portalContactEmail": "string",
   "portalDescription": "string",
   "portalLogoImage": { 
      "file": { 
         "data": blob,
         "type": "string"
      },
      "id": "string"
   },
   "portalName": "string",
   "portalType": "string",
   "portalTypeConfiguration": { 
      "string" : { 
         "portalTools": [ "string" ]
      }
   },
   "roleArn": "string"
}

URI Request Parameters

The request uses the following URI parameters.

portalId

The ID of the portal to update.

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 accepts the following data in JSON format.

alarms

Contains the configuration information of an alarm created in an AWS 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 AWS IoT SiteWise Application Guide.

Type: Alarms object

Required: No

clientToken

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.

Type: String

Length Constraints: Minimum length of 36. Maximum length of 64.

Pattern: \S{36,64}

Required: No

notificationSenderEmail

The email address that sends alarm notifications.

Type: String

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

Pattern: ^[a-zA-Z0-9_\-\.\+]+@[a-zA-Z0-9_\-\.\+]+\.[a-zA-Z]{2,}$

Required: No

portalContactEmail

The AWS administrator's contact email address.

Type: String

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

Pattern: ^[a-zA-Z0-9_\-\.\+]+@[a-zA-Z0-9_\-\.\+]+\.[a-zA-Z]{2,}$

Required: Yes

portalDescription

A new description for the portal.

Type: String

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

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

Required: No

portalLogoImage

Contains an image that is one of the following:

An image file. Choose this option to upload a new image.
The ID of an existing image. Choose this option to keep an existing image.

Type: Image object

Required: No

portalName

A new friendly name for the portal.

Type: String

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

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

Required: Yes

portalType

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

Type: String

Valid Values: SITEWISE_PORTAL_V1 | SITEWISE_PORTAL_V2

Required: No

portalTypeConfiguration

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

Type: String to PortalTypeEntry object map

Key Length Constraints: Minimum length of 1. Maximum length of 128.

Required: No

roleArn

The ARN of a 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-:\/_\.\+=,@]+$

Required: Yes

Response Syntax


HTTP/1.1 202
Content-type: application/json

{
   "portalStatus": { 
      "error": { 
         "code": "string",
         "message": "string"
      },
      "state": "string"
   }
}

Response Elements

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

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

portalStatus

The status of the portal, which contains a state (UPDATING after successfully calling this operation) and any error message.

Type: PortalStatus object

Errors

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

ConflictingOperationException

Your request has conflicting operations. This can occur if you're trying to perform more than one operation on the same resource at the same time.

HTTP Status Code: 409

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