WorkSpacesWeb / Client / create_portal

create_portal#

WorkSpacesWeb.Client.create_portal(**kwargs)#

Creates a web portal.

See also: AWS API Documentation

Request Syntax

response = client.create_portal(
    additionalEncryptionContext={
        'string': 'string'
    },
    authenticationType='Standard'|'IAM_Identity_Center',
    clientToken='string',
    customerManagedKey='string',
    displayName='string',
    tags=[
        {
            'Key': 'string',
            'Value': 'string'
        },
    ]
)
Parameters:

  • additionalEncryptionContext (dict) –

    The additional encryption context of the portal.

    • (string) –

      • (string) –

  • authenticationType (string) –

    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 AWS IAM Identity Center (successor to AWS Single Sign-On). They provide additional features, such as IdP-initiated authentication. 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) –

    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 AWS SDK.

    This field is autopopulated if not provided.

  • customerManagedKey (string) – The customer managed key of the web portal.

  • displayName (string) – The name of the web portal. This is not visible to users who log into the web portal.

  • tags (list) –

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

    • (dict) –

      The tag.

      • Key (string) – [REQUIRED]

        The key of the tag.

      • Value (string) – [REQUIRED]

        The value of the tag

Return type:

dict

Returns:

Response Syntax

{
    'portalArn': 'string',
    'portalEndpoint': 'string'
}

Response Structure

  • (dict) –

    • portalArn (string) –

      The ARN of the web portal.

    • portalEndpoint (string) –

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

Exceptions

  • WorkSpacesWeb.Client.exceptions.InternalServerException

  • WorkSpacesWeb.Client.exceptions.ResourceNotFoundException

  • WorkSpacesWeb.Client.exceptions.AccessDeniedException

  • WorkSpacesWeb.Client.exceptions.ThrottlingException

  • WorkSpacesWeb.Client.exceptions.ServiceQuotaExceededException

  • WorkSpacesWeb.Client.exceptions.ValidationException

  • WorkSpacesWeb.Client.exceptions.ConflictException