WorkSpaces / Client / describe_client_branding

describe_client_branding#

WorkSpaces.Client.describe_client_branding(**kwargs)#

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.

Note

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

See also: AWS API Documentation

Request Syntax

response = client.describe_client_branding(
    ResourceId='string'
)
Parameters:

ResourceId (string) –

[REQUIRED]

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

Return type:

dict

Returns:

Response Syntax

{
    'DeviceTypeWindows': {
        'LogoUrl': 'string',
        'SupportEmail': 'string',
        'SupportLink': 'string',
        'ForgotPasswordLink': 'string',
        'LoginMessage': {
            'string': 'string'
        }
    },
    'DeviceTypeOsx': {
        'LogoUrl': 'string',
        'SupportEmail': 'string',
        'SupportLink': 'string',
        'ForgotPasswordLink': 'string',
        'LoginMessage': {
            'string': 'string'
        }
    },
    'DeviceTypeAndroid': {
        'LogoUrl': 'string',
        'SupportEmail': 'string',
        'SupportLink': 'string',
        'ForgotPasswordLink': 'string',
        'LoginMessage': {
            'string': 'string'
        }
    },
    'DeviceTypeIos': {
        'LogoUrl': 'string',
        'Logo2xUrl': 'string',
        'Logo3xUrl': 'string',
        'SupportEmail': 'string',
        'SupportLink': 'string',
        'ForgotPasswordLink': 'string',
        'LoginMessage': {
            'string': 'string'
        }
    },
    'DeviceTypeLinux': {
        'LogoUrl': 'string',
        'SupportEmail': 'string',
        'SupportLink': 'string',
        'ForgotPasswordLink': 'string',
        'LoginMessage': {
            'string': 'string'
        }
    },
    'DeviceTypeWeb': {
        'LogoUrl': 'string',
        'SupportEmail': 'string',
        'SupportLink': 'string',
        'ForgotPasswordLink': 'string',
        'LoginMessage': {
            'string': 'string'
        }
    }
}

Response Structure

  • (dict) –

    • DeviceTypeWindows (dict) –

      The branding information for Windows devices.

      • LogoUrl (string) –

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

      • SupportEmail (string) –

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

        Note

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

      • SupportLink (string) –

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

        Note

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

      • ForgotPasswordLink (string) –

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

      • LoginMessage (dict) –

        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.

        • (string) –

          • (string) –

    • DeviceTypeOsx (dict) –

      The branding information for macOS devices.

      • LogoUrl (string) –

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

      • SupportEmail (string) –

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

        Note

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

      • SupportLink (string) –

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

        Note

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

      • ForgotPasswordLink (string) –

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

      • LoginMessage (dict) –

        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.

        • (string) –

          • (string) –

    • DeviceTypeAndroid (dict) –

      The branding information for Android devices.

      • LogoUrl (string) –

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

      • SupportEmail (string) –

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

        Note

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

      • SupportLink (string) –

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

        Note

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

      • ForgotPasswordLink (string) –

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

      • LoginMessage (dict) –

        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.

        • (string) –

          • (string) –

    • DeviceTypeIos (dict) –

      The branding information for iOS devices.

      • LogoUrl (string) –

        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.

      • Logo2xUrl (string) –

        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.

        Note

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

      • Logo3xUrl (string) –

        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.

        Note

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

      • SupportEmail (string) –

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

        Note

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

      • SupportLink (string) –

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

        Note

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

      • ForgotPasswordLink (string) –

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

      • LoginMessage (dict) –

        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.

        • (string) –

          • (string) –

    • DeviceTypeLinux (dict) –

      The branding information for Linux devices.

      • LogoUrl (string) –

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

      • SupportEmail (string) –

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

        Note

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

      • SupportLink (string) –

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

        Note

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

      • ForgotPasswordLink (string) –

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

      • LoginMessage (dict) –

        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.

        • (string) –

          • (string) –

    • DeviceTypeWeb (dict) –

      The branding information for Web access.

      • LogoUrl (string) –

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

      • SupportEmail (string) –

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

        Note

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

      • SupportLink (string) –

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

        Note

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

      • ForgotPasswordLink (string) –

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

      • LoginMessage (dict) –

        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.

        • (string) –

          • (string) –

Exceptions