CreatePortal - AWS IoT SiteWise

CreatePortal

Creates a portal, which can contain projects and dashboards. Before you can create a portal, you must enable AWS Single Sign-On. AWS IoT SiteWise Monitor uses AWS SSO to manage user permissions. For more information, see Enabling AWS SSO in the AWS IoT SiteWise User Guide.

Note

Before you can sign in to a new portal, you must add at least one AWS SSO user or group to that portal. For more information, see Adding or removing portal administrators in the AWS IoT SiteWise User Guide.

Request Syntax

POST /portals HTTP/1.1 Content-type: application/json { "clientToken": "string", "portalContactEmail": "string", "portalDescription": "string", "portalLogoImageFile": { "data": blob, "type": "string" }, "portalName": "string", "roleArn": "string", "tags": { "string" : "string" } }

URI Request Parameters

The request does not use any URI parameters.

Request Body

The request accepts the following data in JSON format.

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

portalContactEmail

The AWS administrator's contact email address.

Type: String

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

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

Required: Yes

portalDescription

A description for the portal.

Type: String

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

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

Required: No

portalLogoImageFile

A logo image to display in the portal. Upload a square, high-resolution image. The image is displayed on a dark background.

Type: ImageFile object

Required: No

portalName

A friendly name for the portal.

Type: String

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

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

Required: Yes

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: .*

Required: Yes

tags

A list of key-value pairs that contain metadata for the portal. For more information, see Tagging your AWS IoT SiteWise resources in the AWS IoT SiteWise User Guide.

Type: String to string map

Map Entries: Maximum number of 50 items.

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

Value Length Constraints: Minimum length of 0. Maximum length of 256.

Required: No

Response Syntax

HTTP/1.1 202 Content-type: application/json { "portalArn": "string", "portalId": "string", "portalStartUrl": "string", "portalStatus": { "error": { "code": "string", "message": "string" }, "state": "string" }, "ssoApplicationId": "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.

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: .*

portalId

The ID of the created 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}$

portalStartUrl

The public URL for the AWS IoT SiteWise Monitor portal.

Type: String

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

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

portalStatus

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

Type: PortalStatus object

ssoApplicationId

The associated AWS SSO application Id.

Type: String

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

Pattern: ^[!-~]*

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

LimitExceededException

You've reached the limit for a resource. For example, this can occur if you're trying to associate more than the allowed number of child assets or attempting to create more than the allowed number of properties for an asset model.

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

HTTP Status Code: 410

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

See Also

For more information about using this API in one of the language-specific AWS SDKs, see the following: