WorkSpacesWeb / Client / get_portal

get_portal

WorkSpacesWeb.Client.get_portal(**kwargs)

Gets the web portal.

See also: AWS API Documentation

Request Syntax

response = client.get_portal(
    portalArn='string'
)

Parameters:

portalArn (string) –

[REQUIRED]

The ARN of the web portal.

Return type:

dict

Returns:

Response Syntax

{
    'portal': {
        'additionalEncryptionContext': {
            'string': 'string'
        },
        'authenticationType': 'Standard'|'IAM_Identity_Center',
        'browserSettingsArn': 'string',
        'browserType': 'Chrome',
        'creationDate': datetime(2015, 1, 1),
        'customerManagedKey': 'string',
        'dataProtectionSettingsArn': 'string',
        'displayName': 'string',
        'instanceType': 'standard.regular'|'standard.large'|'standard.xlarge',
        'ipAccessSettingsArn': 'string',
        'maxConcurrentSessions': 123,
        'networkSettingsArn': 'string',
        'portalArn': 'string',
        'portalEndpoint': 'string',
        'portalStatus': 'Incomplete'|'Pending'|'Active',
        'rendererType': 'AppStream',
        'statusReason': 'string',
        'trustStoreArn': 'string',
        'userAccessLoggingSettingsArn': 'string',
        'userSettingsArn': 'string'
    }
}

Response Structure

• (dict) –

  • portal (dict) –

    The web portal.

    • 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 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.

    • browserSettingsArn (string) –

      The ARN of the browser settings that is associated with this web portal.

    • browserType (string) –

      The browser that users see when using a streaming session.

    • creationDate (datetime) –

      The creation date of the web portal.

    • customerManagedKey (string) –

      The customer managed key used to encrypt sensitive information in the portal.

    • dataProtectionSettingsArn (string) –

      The ARN of the data protection settings.

    • displayName (string) –

      The name of the web portal.

    • instanceType (string) –

      The type and resources of the underlying instance.

    • ipAccessSettingsArn (string) –

      The ARN of the IP access settings.

    • maxConcurrentSessions (integer) –

      The maximum number of concurrent sessions for the portal.

    • networkSettingsArn (string) –

      The ARN of the network settings that is associated with the web portal.

    • 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.

    • portalStatus (string) –

      The status of the web portal.

    • rendererType (string) –

      The renderer that is used in streaming sessions.

    • statusReason (string) –

      A message that explains why the web portal is in its current status.

    • trustStoreArn (string) –

      The ARN of the trust store that is associated with the web portal.

    • userAccessLoggingSettingsArn (string) –

      The ARN of the user access logging settings that is associated with the web portal.

    • userSettingsArn (string) –

      The ARN of the user settings that is associated with the web portal.

Exceptions

• WorkSpacesWeb.Client.exceptions.InternalServerException

• WorkSpacesWeb.Client.exceptions.ResourceNotFoundException

• WorkSpacesWeb.Client.exceptions.AccessDeniedException

• WorkSpacesWeb.Client.exceptions.ThrottlingException

• WorkSpacesWeb.Client.exceptions.ValidationException