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

GetPortal

Gets the web portal.

Request Syntax


GET /portals/portalArn+ HTTP/1.1

URI Request Parameters

The request uses the following URI parameters.

portalArn

The ARN of the web portal.

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

Pattern: ^arn:[\w+=\/,.@-]+:[a-zA-Z0-9\-]+:[a-zA-Z0-9\-]*:[a-zA-Z0-9]{1,12}:[a-zA-Z]+(\/[a-fA-F0-9\-]{36})+$

Required: Yes

Request Body

The request does not have a request body.

Response Syntax


HTTP/1.1 200
Content-type: application/json

{
   "portal": { 
      "additionalEncryptionContext": { 
         "string" : "string" 
      },
      "authenticationType": "string",
      "browserSettingsArn": "string",
      "browserType": "string",
      "creationDate": number,
      "customerManagedKey": "string",
      "dataProtectionSettingsArn": "string",
      "displayName": "string",
      "instanceType": "string",
      "ipAccessSettingsArn": "string",
      "maxConcurrentSessions": number,
      "networkSettingsArn": "string",
      "portalArn": "string",
      "portalEndpoint": "string",
      "portalStatus": "string",
      "rendererType": "string",
      "statusReason": "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.

portal

The web portal.

Type: Portal object

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.

HTTP Status Code: 500

ResourceNotFoundException

The resource cannot be found.

HTTP Status Code: 404

ThrottlingException

There is a throttling error.

HTTP Status Code: 429

ValidationException

There is a validation error.

HTTP Status Code: 400