UpdatePortal - WorkSpacesWeb


Updates a web portal.

Request Syntax

PUT /portals/portalArn+ HTTP/1.1 Content-type: application/json { "displayName": "string" }

URI Request Parameters

The request uses the following URI parameters.


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


The name of the web portal. This is not visible to users who log into the web portal.

Type: String

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

Pattern: ^.+$

Required: No

Response Syntax

HTTP/1.1 200 Content-type: application/json { "portal": { "browserSettingsArn": "string", "browserType": "string", "creationDate": number, "displayName": "string", "networkSettingsArn": "string", "portalArn": "string", "portalEndpoint": "string", "portalStatus": "string", "rendererType": "string", "statusReason": "string", "trustStoreArn": "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.


The web portal.

Type: Portal object


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


Access is denied.

HTTP Status Code: 403


There is an internal server error.

HTTP Status Code: 500


The resource cannot be found.

HTTP Status Code: 404


There is a throttling error.

HTTP Status Code: 429


There is a validation error.

HTTP Status Code: 400

See Also

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