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

ListPortals

Retrieves a list or web 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 included in the next page.

Valid Range: Minimum value of 1.

nextToken

The pagination token used to retrieve the next page of results for this operation.

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

Pattern: \S+

Request Body

The request does not have a request body.

Response Syntax


HTTP/1.1 200
Content-type: application/json

{
   "nextToken": "string",
   "portals": [ 
      { 
         "authenticationType": "string",
         "browserSettingsArn": "string",
         "browserType": "string",
         "creationDate": number,
         "dataProtectionSettingsArn": "string",
         "displayName": "string",
         "instanceType": "string",
         "ipAccessSettingsArn": "string",
         "maxConcurrentSessions": number,
         "networkSettingsArn": "string",
         "portalArn": "string",
         "portalEndpoint": "string",
         "portalStatus": "string",
         "rendererType": "string",
         "sessionLoggerArn": "string",
         "trustStoreArn": "string",
         "userAccessLoggingSettingsArn": "string",
         "userSettingsArn": "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 pagination token used to retrieve the next page of results for this operation.

Type: String

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

Pattern: \S+

portals

The portals in the list.

Type: Array of PortalSummary objects

Errors

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

AccessDeniedException

Access is denied.

HTTP Status Code: 403

InternalServerException

There is an internal server error.

retryAfterSeconds: Advice to clients on when the call can be safely retried.

HTTP Status Code: 500

ThrottlingException

There is a throttling error.

quotaCode: The originating quota.
retryAfterSeconds: Advice to clients on when the call can be safely retried.
serviceCode: The originating service.

HTTP Status Code: 429

ValidationException

There is a validation error.

fieldList: The field that caused the error.
reason: Reason the request failed validation

HTTP Status Code: 400