Skip to content
AWS for Query.Farm

aws.workspaces_web.list_portals

Example SQL Queries

SELECT * FROM
aws.workspaces_web.list_portals;

Description

Retrieves a list or web portals.

Table Definition

Column NameColumn Data Type
max_results Input Column

The maximum number of results to be included in the next page.

BIGINT
next_token Input Column

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

VARCHAR
_aws_profile Input Column

The AWS profile defines the AWS identity used. It can be defined via credentials or by assuming a IAM role.

STRUCT(
    "type" VARCHAR,
    "name" VARCHAR,
    "account_id" VARCHAR,
    "via_profile_name" VARCHAR,
    "assumed_role_arn" VARCHAR,
    "organization" STRUCT(
        "account_name" VARCHAR,
        "id" VARCHAR,
        "tags" STRUCT(
            "key" VARCHAR,
            "value" VARCHAR
        )[],
        "master_account" STRUCT(
            "id" VARCHAR,
            "email" VARCHAR
        ),
        "parents" STRUCT(
            "type" VARCHAR,
            "id" VARCHAR,
            "name" VARCHAR,
            "tags" STRUCT(
                "key" VARCHAR,
                "value" VARCHAR
            )[]
        )[]
    )
)
Show child fields
_aws_profile.account_id

The AWS account id

_aws_profile.assumed_role_arn

The ARN of the assumed role

_aws_profile.name

The unique name of the profile.

_aws_profile.organization

Information about this profile's membership in the AWS organization.

Show child fields
_aws_profile.organization.account_name

The name of account speciifed by the organization

_aws_profile.organization.id

The organization id

_aws_profile.organization.master_account
Show child fields
_aws_profile.organization.master_account.email

The organization master account email address

_aws_profile.organization.master_account.id

The organization master account id

_aws_profile.organization.parents[]
Show child fields
_aws_profile.organization.parents[].id

The id of the parent

_aws_profile.organization.parents[].name

The name of the parent

_aws_profile.organization.parents[].tags[]
Show child fields
_aws_profile.organization.parents[].tags[].key
_aws_profile.organization.parents[].tags[].value
_aws_profile.organization.parents[].type

The type of parent can be an organization unit or a root

_aws_profile.organization.tags[]
Show child fields
_aws_profile.organization.tags[].key
_aws_profile.organization.tags[].value
_aws_profile.type

The type of profile, either 'credentials' or 'assumed_role'

_aws_profile.via_profile_name

This IAM role for this profile is assumed by first utilizing another profile with this name to obtain credentials.

_aws_region Input Column

The AWS region to use.

VARCHAR
portals

The portals in the list.

STRUCT(
    "authentication_type" VARCHAR,
    "browser_settings_arn" VARCHAR,
    "browser_type" VARCHAR,
    "creation_date" TIMESTAMP_S,
    "display_name" VARCHAR,
    "instance_type" VARCHAR,
    "ip_access_settings_arn" VARCHAR,
    "max_concurrent_sessions" BIGINT,
    "network_settings_arn" VARCHAR,
    "portal_arn" VARCHAR,
    "portal_endpoint" VARCHAR,
    "portal_status" VARCHAR,
    "renderer_type" VARCHAR,
    "trust_store_arn" VARCHAR,
    "user_access_logging_settings_arn" VARCHAR,
    "user_settings_arn" VARCHAR
)[]
Show child fields
portals[]
Show child fields
portals[].authentication_type

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 (successor to Single Sign-On). Identity sources (including external identity provider integration), plus user and group access to your web portal, can be configured in the IAM Identity Center.

portals[].browser_settings_arn

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

portals[].browser_type

The browser type of the web portal.

portals[].creation_date

The creation date of the web portal.

portals[].display_name

The name of the web portal.

portals[].instance_type

The type and resources of the underlying instance.

portals[].ip_access_settings_arn

The ARN of the IP access settings.

portals[].max_concurrent_sessions

The maximum number of concurrent sessions for the portal.

portals[].network_settings_arn

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

portals[].portal_arn

The ARN of the web portal.

portals[].portal_endpoint

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

portals[].portal_status

The status of the web portal.

portals[].renderer_type

The renderer that is used in streaming sessions.

portals[].trust_store_arn

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

portals[].user_access_logging_settings_arn

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

portals[].user_settings_arn

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