Creates a web portal.
post/portals
Request body
displayNamestring password
The name of the web portal. This is not visible to users who log into the web portal.
customerManagedKeystring
The customer managed key of the web portal.
additionalEncryptionContextobject
The additional encryption context of the portal.
clientTokenstring
<p>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. </p> <p>If you do not specify a client token, one is automatically generated by the Amazon Web Services SDK.</p>
authenticationType'Standard' | 'IAM_Identity_Center'
<p>The type of authentication integration points used when signing into the web portal. Defaults to <code>Standard</code>.</p> <p> <code>Standard</code> web portals are authenticated directly through your identity provider. You need to call <code>CreateIdentityProvider</code> to integrate your identity provider with your web portal. User and group access to your web portal is controlled through your identity provider.</p> <p> <code>IAM Identity Center</code> 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.</p>
instanceType'standard.regular' | 'standard.large' | 'standard.xlarge'
The type and resources of the underlying instance.
maxConcurrentSessionsinteger
The maximum number of concurrent sessions for the portal.
portalCustomDomainstring
The custom domain of the web portal that users access in order to start streaming sessions.
Response
Success
portalArnstring required
The ARN of the web portal.
portalEndpointstring required
The endpoint URL of the web portal that users access in order to start streaming sessions.