ListPortals - AWS IoT SiteWise

ListPortals

Retrieves a paginated list of AWS IoT SiteWise Monitor portals.

Request Syntax

GET /portals?maxResults=maxResults&nextToken=nextToken HTTP/1.1

URI Request Parameters

The request uses the following URI parameters.

maxResults

The maximum number of results to be returned per paginated request.

Default: 50

Valid Range: Minimum value of 1. Maximum value of 250.

nextToken

The token to be used for the next set of paginated results.

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

Pattern: [A-Za-z0-9+/=]+

Request Body

The request does not have a request body.

Response Syntax

HTTP/1.1 200 Content-type: application/json { "nextToken": "string", "portalSummaries": [ { "creationDate": number, "description": "string", "id": "string", "lastUpdateDate": number, "name": "string", "roleArn": "string", "startUrl": "string", "status": { "error": { "code": "string", "message": "string" }, "state": "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.

nextToken

The token for the next set of results, or null if there are no additional results.

Type: String

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

Pattern: [A-Za-z0-9+/=]+

portalSummaries

A list that summarizes each portal.

Type: Array of PortalSummary objects

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

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: