Skip to content
AWS for Query.Farm

aws.workspaces_web.get_user_settings

Example SQL Queries

SELECT * FROM
aws.workspaces_web.get_user_settings
WHERE
"user_settings_arn" = 'VALUE';

Description

Gets user settings.

Table Definition

Column NameColumn Data Type
user_settings_arn Required Input Column

The ARN of the user settings.

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
user_settings

The user settings.

STRUCT(
    "additional_encryption_context" MAP(VARCHAR, VARCHAR),
    "associated_portal_arns" VARCHAR[],
    "cookie_synchronization_configuration" STRUCT(
        "allowlist" STRUCT(
            "domain" VARCHAR,
            "name" VARCHAR,
            "path" VARCHAR
        )[],
        "blocklist" STRUCT(
            "domain" VARCHAR,
            "name" VARCHAR,
            "path" VARCHAR
        )[]
    ),
    "copy_allowed" VARCHAR,
    "customer_managed_key" VARCHAR,
    "deep_link_allowed" VARCHAR,
    "disconnect_timeout_in_minutes" BIGINT,
    "download_allowed" VARCHAR,
    "idle_disconnect_timeout_in_minutes" BIGINT,
    "paste_allowed" VARCHAR,
    "print_allowed" VARCHAR,
    "upload_allowed" VARCHAR,
    "user_settings_arn" VARCHAR
)
Show child fields
user_settings.additional_encryption_context

The additional encryption context of the user settings.

user_settings.associated_portal_arns[]
user_settings.cookie_synchronization_configuration

The configuration that specifies which cookies should be synchronized from the end user's local browser to the remote browser.

Show child fields
user_settings.cookie_synchronization_configuration.allowlist[]
Show child fields
user_settings.cookie_synchronization_configuration.allowlist[].domain

The domain of the cookie.

user_settings.cookie_synchronization_configuration.allowlist[].name

The name of the cookie.

user_settings.cookie_synchronization_configuration.allowlist[].path

The path of the cookie.

user_settings.cookie_synchronization_configuration.blocklist[]
Show child fields
user_settings.cookie_synchronization_configuration.blocklist[].domain

The domain of the cookie.

user_settings.cookie_synchronization_configuration.blocklist[].name

The name of the cookie.

user_settings.cookie_synchronization_configuration.blocklist[].path

The path of the cookie.

user_settings.copy_allowed

Specifies whether the user can copy text from the streaming session to the local device.

user_settings.customer_managed_key

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

user_settings.deep_link_allowed

Specifies whether the user can use deep links that open automatically when connecting to a session.

user_settings.disconnect_timeout_in_minutes

The amount of time that a streaming session remains active after users disconnect.

user_settings.download_allowed

Specifies whether the user can download files from the streaming session to the local device.

user_settings.idle_disconnect_timeout_in_minutes

The amount of time that users can be idle (inactive) before they are disconnected from their streaming session and the disconnect timeout interval begins.

user_settings.paste_allowed

Specifies whether the user can paste text from the local device to the streaming session.

user_settings.print_allowed

Specifies whether the user can print to the local device.

user_settings.upload_allowed

Specifies whether the user can upload files from the local device to the streaming session.

user_settings.user_settings_arn

The ARN of the user settings.