CreatePortalCommand

Suggest an Edit

Creates a web portal.

Example Syntax

Use a bare-bones client and the command you need to make an API call.

import { WorkSpacesWebClient, CreatePortalCommand } from "@aws-sdk/client-workspaces-web"; // ES Modules import
// const { WorkSpacesWebClient, CreatePortalCommand } = require("@aws-sdk/client-workspaces-web"); // CommonJS import
const client = new WorkSpacesWebClient(config);
const input = { // CreatePortalRequest
  displayName: "STRING_VALUE",
  tags: [ // TagList
    { // Tag
      Key: "STRING_VALUE", // required
      Value: "STRING_VALUE", // required
    },
  ],
  customerManagedKey: "STRING_VALUE",
  additionalEncryptionContext: { // EncryptionContextMap
    "<keys>": "STRING_VALUE",
  },
  clientToken: "STRING_VALUE",
  authenticationType: "STRING_VALUE",
  instanceType: "STRING_VALUE",
  maxConcurrentSessions: Number("int"),
};
const command = new CreatePortalCommand(input);
const response = await client.send(command);
// { // CreatePortalResponse
//   portalArn: "STRING_VALUE", // required
//   portalEndpoint: "STRING_VALUE", // required
// };

CreatePortalCommand Input

See CreatePortalCommandInput for more details

Parameter
Type
Description
additionalEncryptionContext
Record<string, string> | undefined

The additional encryption context of the portal.

authenticationType
AuthenticationType | undefined

The type of authentication integration points used when signing into the web portal. Defaults to Standard.

Standard web portals are authenticated directly through your identity provider. You need to call CreateIdentityProvider to integrate your identity provider with your web portal. User and group access to your web portal is controlled through your identity provider.

IAM Identity Center web portals are authenticated through IAM Identity Center. Identity sources (including external identity provider integration), plus user and group access to your web portal, can be configured in the IAM Identity Center.

clientToken
string | undefined

A unique, case-sensitive identifier that you provide to ensure the idempotency of the request. Idempotency ensures that an API request completes only once. With an idempotent request, if the original request completes successfully, subsequent retries with the same client token returns the result from the original successful request.

If you do not specify a client token, one is automatically generated by the Amazon Web Services SDK.

customerManagedKey
string | undefined

The customer managed key of the web portal.

displayName
string | undefined

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

instanceType
_InstanceType | undefined

The type and resources of the underlying instance.

maxConcurrentSessions
number | undefined

The maximum number of concurrent sessions for the portal.

tags
Tag[] | undefined

The tags to add to the web portal. A tag is a key-value pair.

CreatePortalCommand Output

See CreatePortalCommandOutput for details

Parameter
Type
Description
$metadata
Required
ResponseMetadata
Metadata pertaining to this request.
portalArn
Required
string | undefined

The ARN of the web portal.

portalEndpoint
Required
string | undefined

The endpoint URL of the web portal that users access in order to start streaming sessions.

Throws

Name
Fault
Details
AccessDeniedException
client

Access is denied.

ConflictException
client

There is a conflict.

InternalServerException
server

There is an internal server error.

ResourceNotFoundException
client

The resource cannot be found.

ServiceQuotaExceededException
client

The service quota has been exceeded.

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.