Skip to content
AWS for Query.Farm

aws.workspaces.describe_client_branding

Example SQL Queries

SELECT * FROM
aws.workspaces.describe_client_branding
WHERE
"resource_id" = 'VALUE';

Description

Describes the specified client branding. Client branding allows you to customize the log in page of various device types for your users. You can add your company logo, the support email address, support link, link to reset password, and a custom message for users trying to sign in.

Only device types that have branding information configured will be shown in the response.

Table Definition

Column NameColumn Data Type
resource_id Required Input Column

The directory identifier of the WorkSpace for which you want to view client branding information.

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
device_type_android

The branding information for Android devices.

STRUCT(
    "logo_url" VARCHAR,
    "support_email" VARCHAR,
    "support_link" VARCHAR,
    "forgot_password_link" VARCHAR,
    "login_message" MAP(VARCHAR, VARCHAR)
)
Show child fields
device_type_android.forgot_password_link

The forgotten password link. This is the web address that users can go to if they forget the password for their WorkSpace.

device_type_android.login_message

The login message. Specified as a key value pair, in which the key is a locale and the value is the localized message for that locale. The only key supported is en_US. The HTML tags supported include the following: a, b, blockquote, br, cite, code, dd, dl, dt, div, em, i, li, ol, p, pre, q, small, span, strike, strong, sub, sup, u, ul.

device_type_android.logo_url

The logo. The only image format accepted is a binary data object that is converted from a .png file.

device_type_android.support_email

The support email. The company's customer support email address.

  • In each platform type, the SupportEmail and SupportLink parameters are mutually exclusive. You can specify one parameter for each platform type, but not both.

  • The default email is workspaces-feedback@amazon.com.

device_type_android.support_link

The support link. The link for the company's customer support page for their WorkSpace.

  • In each platform type, the SupportEmail and SupportLink parameters are mutually exclusive.You can specify one parameter for each platform type, but not both.

  • The default support link is workspaces-feedback@amazon.com.

device_type_ios

The branding information for iOS devices.

STRUCT(
    "logo_url" VARCHAR,
    "logo2x_url" VARCHAR,
    "logo3x_url" VARCHAR,
    "support_email" VARCHAR,
    "support_link" VARCHAR,
    "forgot_password_link" VARCHAR,
    "login_message" MAP(VARCHAR, VARCHAR)
)
Show child fields
device_type_ios.forgot_password_link

The forgotten password link. This is the web address that users can go to if they forget the password for their WorkSpace.

device_type_ios.login_message

The login message. Specified as a key value pair, in which the key is a locale and the value is the localized message for that locale. The only key supported is en_US. The HTML tags supported include the following: a, b, blockquote, br, cite, code, dd, dl, dt, div, em, i, li, ol, p, pre, q, small, span, strike, strong, sub, sup, u, ul.

device_type_ios.logo2x_url

The @2x version of the logo. This is the higher resolution display that offers a scale factor of 2.0 (or @2x). The only image format accepted is a binary data object that is converted from a .png file.

For more information about iOS image size and resolution, see Image Size and Resolution in the Apple Human Interface Guidelines.

device_type_ios.logo3x_url

The @3x version of the logo. This is the higher resolution display that offers a scale factor of 3.0 (or @3x).The only image format accepted is a binary data object that is converted from a .png file.

For more information about iOS image size and resolution, see Image Size and Resolution in the Apple Human Interface Guidelines.

device_type_ios.logo_url

The logo. This is the standard-resolution display that has a 1:1 pixel density (or @1x), where one pixel is equal to one point. The only image format accepted is a binary data object that is converted from a .png file.

device_type_ios.support_email

The support email. The company's customer support email address.

  • In each platform type, the SupportEmail and SupportLink parameters are mutually exclusive. You can specify one parameter for each platform type, but not both.

  • The default email is workspaces-feedback@amazon.com.

device_type_ios.support_link

The support link. The link for the company's customer support page for their WorkSpace.

  • In each platform type, the SupportEmail and SupportLink parameters are mutually exclusive. You can specify one parameter for each platform type, but not both.

  • The default support link is workspaces-feedback@amazon.com.

device_type_linux

The branding information for Linux devices.

STRUCT(
    "logo_url" VARCHAR,
    "support_email" VARCHAR,
    "support_link" VARCHAR,
    "forgot_password_link" VARCHAR,
    "login_message" MAP(VARCHAR, VARCHAR)
)
Show child fields
device_type_linux.forgot_password_link

The forgotten password link. This is the web address that users can go to if they forget the password for their WorkSpace.

device_type_linux.login_message

The login message. Specified as a key value pair, in which the key is a locale and the value is the localized message for that locale. The only key supported is en_US. The HTML tags supported include the following: a, b, blockquote, br, cite, code, dd, dl, dt, div, em, i, li, ol, p, pre, q, small, span, strike, strong, sub, sup, u, ul.

device_type_linux.logo_url

The logo. The only image format accepted is a binary data object that is converted from a .png file.

device_type_linux.support_email

The support email. The company's customer support email address.

  • In each platform type, the SupportEmail and SupportLink parameters are mutually exclusive. You can specify one parameter for each platform type, but not both.

  • The default email is workspaces-feedback@amazon.com.

device_type_linux.support_link

The support link. The link for the company's customer support page for their WorkSpace.

  • In each platform type, the SupportEmail and SupportLink parameters are mutually exclusive.You can specify one parameter for each platform type, but not both.

  • The default support link is workspaces-feedback@amazon.com.

device_type_osx

The branding information for macOS devices.

STRUCT(
    "logo_url" VARCHAR,
    "support_email" VARCHAR,
    "support_link" VARCHAR,
    "forgot_password_link" VARCHAR,
    "login_message" MAP(VARCHAR, VARCHAR)
)
Show child fields
device_type_osx.forgot_password_link

The forgotten password link. This is the web address that users can go to if they forget the password for their WorkSpace.

device_type_osx.login_message

The login message. Specified as a key value pair, in which the key is a locale and the value is the localized message for that locale. The only key supported is en_US. The HTML tags supported include the following: a, b, blockquote, br, cite, code, dd, dl, dt, div, em, i, li, ol, p, pre, q, small, span, strike, strong, sub, sup, u, ul.

device_type_osx.logo_url

The logo. The only image format accepted is a binary data object that is converted from a .png file.

device_type_osx.support_email

The support email. The company's customer support email address.

  • In each platform type, the SupportEmail and SupportLink parameters are mutually exclusive. You can specify one parameter for each platform type, but not both.

  • The default email is workspaces-feedback@amazon.com.

device_type_osx.support_link

The support link. The link for the company's customer support page for their WorkSpace.

  • In each platform type, the SupportEmail and SupportLink parameters are mutually exclusive.You can specify one parameter for each platform type, but not both.

  • The default support link is workspaces-feedback@amazon.com.

device_type_web

The branding information for Web access.

STRUCT(
    "logo_url" VARCHAR,
    "support_email" VARCHAR,
    "support_link" VARCHAR,
    "forgot_password_link" VARCHAR,
    "login_message" MAP(VARCHAR, VARCHAR)
)
Show child fields
device_type_web.forgot_password_link

The forgotten password link. This is the web address that users can go to if they forget the password for their WorkSpace.

device_type_web.login_message

The login message. Specified as a key value pair, in which the key is a locale and the value is the localized message for that locale. The only key supported is en_US. The HTML tags supported include the following: a, b, blockquote, br, cite, code, dd, dl, dt, div, em, i, li, ol, p, pre, q, small, span, strike, strong, sub, sup, u, ul.

device_type_web.logo_url

The logo. The only image format accepted is a binary data object that is converted from a .png file.

device_type_web.support_email

The support email. The company's customer support email address.

  • In each platform type, the SupportEmail and SupportLink parameters are mutually exclusive. You can specify one parameter for each platform type, but not both.

  • The default email is workspaces-feedback@amazon.com.

device_type_web.support_link

The support link. The link for the company's customer support page for their WorkSpace.

  • In each platform type, the SupportEmail and SupportLink parameters are mutually exclusive.You can specify one parameter for each platform type, but not both.

  • The default support link is workspaces-feedback@amazon.com.

device_type_windows

The branding information for Windows devices.

STRUCT(
    "logo_url" VARCHAR,
    "support_email" VARCHAR,
    "support_link" VARCHAR,
    "forgot_password_link" VARCHAR,
    "login_message" MAP(VARCHAR, VARCHAR)
)
Show child fields
device_type_windows.forgot_password_link

The forgotten password link. This is the web address that users can go to if they forget the password for their WorkSpace.

device_type_windows.login_message

The login message. Specified as a key value pair, in which the key is a locale and the value is the localized message for that locale. The only key supported is en_US. The HTML tags supported include the following: a, b, blockquote, br, cite, code, dd, dl, dt, div, em, i, li, ol, p, pre, q, small, span, strike, strong, sub, sup, u, ul.

device_type_windows.logo_url

The logo. The only image format accepted is a binary data object that is converted from a .png file.

device_type_windows.support_email

The support email. The company's customer support email address.

  • In each platform type, the SupportEmail and SupportLink parameters are mutually exclusive. You can specify one parameter for each platform type, but not both.

  • The default email is workspaces-feedback@amazon.com.

device_type_windows.support_link

The support link. The link for the company's customer support page for their WorkSpace.

  • In each platform type, the SupportEmail and SupportLink parameters are mutually exclusive.You can specify one parameter for each platform type, but not both.

  • The default support link is workspaces-feedback@amazon.com.