WorkSpacesWeb / Client / list_portals

list_portals

WorkSpacesWeb.Client.list_portals(**kwargs)

Retrieves a list or web portals.

See also: AWS API Documentation

Request Syntax

response = client.list_portals(
    maxResults=123,
    nextToken='string'
)

Parameters:

• maxResults (integer) – The maximum number of results to be included in the next page.

• nextToken (string) – The pagination token used to retrieve the next page of results for this operation.

Return type:

dict

Returns:

Response Syntax

{
    'nextToken': 'string',
    'portals': [
        {
            'authenticationType': 'Standard'|'IAM_Identity_Center',
            'browserSettingsArn': 'string',
            'browserType': 'Chrome',
            'creationDate': datetime(2015, 1, 1),
            'displayName': 'string',
            'networkSettingsArn': 'string',
            'portalArn': 'string',
            'portalEndpoint': 'string',
            'portalStatus': 'Incomplete'|'Pending'|'Active',
            'rendererType': 'AppStream',
            'trustStoreArn': 'string',
            'userAccessLoggingSettingsArn': 'string',
            'userSettingsArn': 'string'
        },
    ]
}

Response Structure

• (dict) –

  • nextToken (string) –

    The pagination token used to retrieve the next page of results for this operation.

  • portals (list) –

    The portals in the list.

    • (dict) –

      The summary of the portal.

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

      • browserSettingsArn (string) –

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

      • browserType (string) –

        The browser type of the web portal.

      • creationDate (datetime) –

        The creation date of the web portal.

      • displayName (string) –

        The name of the web 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.

      • trustStoreArn (string) –

        The ARN of the trust that is associated with this 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.AccessDeniedException

• WorkSpacesWeb.Client.exceptions.ThrottlingException

• WorkSpacesWeb.Client.exceptions.ValidationException