- Navigation GuideYou are on a Command (operation) page with structural examples. Use the navigation breadcrumb if you would like to return to the Client landing page.
GetPortalCommand
Gets the web portal.
Example Syntax
Use a bare-bones client and the command you need to make an API call.
import { WorkSpacesWebClient, GetPortalCommand } from "@aws-sdk/client-workspaces-web"; // ES Modules import
// const { WorkSpacesWebClient, GetPortalCommand } = require("@aws-sdk/client-workspaces-web"); // CommonJS import
const client = new WorkSpacesWebClient(config);
const input = { // GetPortalRequest
portalArn: "STRING_VALUE", // required
};
const command = new GetPortalCommand(input);
const response = await client.send(command);
// { // GetPortalResponse
// portal: { // Portal
// portalArn: "STRING_VALUE", // required
// rendererType: "STRING_VALUE",
// browserType: "STRING_VALUE",
// portalStatus: "STRING_VALUE",
// portalEndpoint: "STRING_VALUE",
// displayName: "STRING_VALUE",
// creationDate: new Date("TIMESTAMP"),
// browserSettingsArn: "STRING_VALUE",
// dataProtectionSettingsArn: "STRING_VALUE",
// userSettingsArn: "STRING_VALUE",
// networkSettingsArn: "STRING_VALUE",
// trustStoreArn: "STRING_VALUE",
// statusReason: "STRING_VALUE",
// userAccessLoggingSettingsArn: "STRING_VALUE",
// authenticationType: "STRING_VALUE",
// ipAccessSettingsArn: "STRING_VALUE",
// customerManagedKey: "STRING_VALUE",
// additionalEncryptionContext: { // EncryptionContextMap
// "<keys>": "STRING_VALUE",
// },
// instanceType: "STRING_VALUE",
// maxConcurrentSessions: Number("int"),
// },
// };
GetPortalCommand Input
See GetPortalCommandInput for more details
Parameter | Type | Description |
---|
Parameter | Type | Description |
---|---|---|
portalArn Required | string | undefined | The ARN of the web portal. |
GetPortalCommand Output
See GetPortalCommandOutput for details
Parameter | Type | Description |
---|
Parameter | Type | Description |
---|---|---|
$metadata Required | ResponseMetadata | Metadata pertaining to this request. |
portal | Portal | undefined | The web portal. |
Throws
Name | Fault | Details |
---|
Name | Fault | Details |
---|---|---|
AccessDeniedException | client | Access is denied. |
InternalServerException | server | There is an internal server error. |
ResourceNotFoundException | client | The resource cannot be found. |
ThrottlingException | client | There is a throttling error. |
ValidationException | client | There is a validation error. |
WorkSpacesWebServiceException | Base exception class for all service exceptions from WorkSpacesWeb service. |