Amazon WorkSpaces

2022/03/31 - Amazon WorkSpaces - 3 new api methods

Changes  Added APIs that allow you to customize the logo, login message, and help links in the WorkSpaces client login page. To learn more, visit https://docs.aws.amazon.com/workspaces/latest/adminguide/customize-branding.html

ImportClientBranding (new) Link ¶

Imports client branding. Client branding allows you to customize your WorkSpace's client login portal. You can tailor your login portal company logo, the support email address, support link, link to reset password, and a custom message for users trying to sign in.

After you import client branding, the default branding experience for the specified platform type is replaced with the imported experience

See also: AWS API Documentation

Request Syntax

client.import_client_branding(
    ResourceId='string',
    DeviceTypeWindows={
        'Logo': b'bytes',
        'SupportEmail': 'string',
        'SupportLink': 'string',
        'ForgotPasswordLink': 'string',
        'LoginMessage': {
            'string': 'string'
        }
    },
    DeviceTypeOsx={
        'Logo': b'bytes',
        'SupportEmail': 'string',
        'SupportLink': 'string',
        'ForgotPasswordLink': 'string',
        'LoginMessage': {
            'string': 'string'
        }
    },
    DeviceTypeAndroid={
        'Logo': b'bytes',
        'SupportEmail': 'string',
        'SupportLink': 'string',
        'ForgotPasswordLink': 'string',
        'LoginMessage': {
            'string': 'string'
        }
    },
    DeviceTypeIos={
        'Logo': b'bytes',
        'Logo2x': b'bytes',
        'Logo3x': b'bytes',
        'SupportEmail': 'string',
        'SupportLink': 'string',
        'ForgotPasswordLink': 'string',
        'LoginMessage': {
            'string': 'string'
        }
    },
    DeviceTypeLinux={
        'Logo': b'bytes',
        'SupportEmail': 'string',
        'SupportLink': 'string',
        'ForgotPasswordLink': 'string',
        'LoginMessage': {
            'string': 'string'
        }
    },
    DeviceTypeWeb={
        'Logo': b'bytes',
        'SupportEmail': 'string',
        'SupportLink': 'string',
        'ForgotPasswordLink': 'string',
        'LoginMessage': {
            'string': 'string'
        }
    }
)
type ResourceId:

string

param ResourceId:

[REQUIRED]

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

type DeviceTypeWindows:

dict

param DeviceTypeWindows:

The branding information to import for Windows devices.

  • Logo (bytes) --

    The logo. This is the link where users can download the logo image. The only image format accepted is .png.

  • SupportEmail (string) --

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

  • SupportLink (string) --

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

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

    • (string) --

      • (string) --

type DeviceTypeOsx:

dict

param DeviceTypeOsx:

The branding information to import for macOS devices.

  • Logo (bytes) --

    The logo. This is the link where users can download the logo image. The only image format accepted is .png.

  • SupportEmail (string) --

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

  • SupportLink (string) --

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

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

    • (string) --

      • (string) --

type DeviceTypeAndroid:

dict

param DeviceTypeAndroid:

The branding information to import for Android devices.

  • Logo (bytes) --

    The logo. This is the link where users can download the logo image. The only image format accepted is .png.

  • SupportEmail (string) --

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

  • SupportLink (string) --

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

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

    • (string) --

      • (string) --

type DeviceTypeIos:

dict

param DeviceTypeIos:

The branding information to import for iOS devices.

  • Logo (bytes) --

    The logo. This is the link where users can download the logo image. This is the standard-resolution display that has a 1:1 pixel density (or @1x), where one pixel is equal to one point.

  • Logo2x (bytes) --

    The @2x version of the logo. This is the higher resolution display that offers a scale factor of 2.0 (or @2x).

  • Logo3x (bytes) --

    The @3x version of the logo. This is the higher resolution display that offers a scale factor of 3.0 (or @3x).

  • SupportEmail (string) --

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

  • SupportLink (string) --

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

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

    • (string) --

      • (string) --

type DeviceTypeLinux:

dict

param DeviceTypeLinux:

The branding information to import for Linux devices.

  • Logo (bytes) --

    The logo. This is the link where users can download the logo image. The only image format accepted is .png.

  • SupportEmail (string) --

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

  • SupportLink (string) --

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

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

    • (string) --

      • (string) --

type DeviceTypeWeb:

dict

param DeviceTypeWeb:

The branding information to import for web access.

  • Logo (bytes) --

    The logo. This is the link where users can download the logo image. The only image format accepted is .png.

  • SupportEmail (string) --

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

  • SupportLink (string) --

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

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

    • (string) --

      • (string) --

rtype:

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 configured for Windows devices.

      • LogoUrl (string) --

        The logo URL. This is the link where users can download the logo image. The only supported image format is .png.

      • SupportEmail (string) --

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

      • SupportLink (string) --

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

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

        • (string) --

          • (string) --

    • DeviceTypeOsx (dict) --

      The branding information configured for macOS devices.

      • LogoUrl (string) --

        The logo URL. This is the link where users can download the logo image. The only supported image format is .png.

      • SupportEmail (string) --

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

      • SupportLink (string) --

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

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

        • (string) --

          • (string) --

    • DeviceTypeAndroid (dict) --

      The branding information configured for Android devices.

      • LogoUrl (string) --

        The logo URL. This is the link where users can download the logo image. The only supported image format is .png.

      • SupportEmail (string) --

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

      • SupportLink (string) --

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

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

        • (string) --

          • (string) --

    • DeviceTypeIos (dict) --

      The branding information configured for iOS devices.

      • LogoUrl (string) --

        The logo. This is the link where users can download the logo image. This is the standard-resolution display that has a 1:1 pixel density (or @1x), where one pixel is equal to one point.

      • Logo2xUrl (string) --

        The @2x version of the logo. This is the higher resolution display that offers a scale factor of 2.0 (or @2x).

      • Logo3xUrl (string) --

        The @3x version of the logo. This is the higher resolution display that offers a scale factor of 3.0 (or @3x).

      • SupportEmail (string) --

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

      • SupportLink (string) --

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

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

        • (string) --

          • (string) --

    • DeviceTypeLinux (dict) --

      The branding information configured for Linux devices.

      • LogoUrl (string) --

        The logo URL. This is the link where users can download the logo image. The only supported image format is .png.

      • SupportEmail (string) --

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

      • SupportLink (string) --

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

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

        • (string) --

          • (string) --

    • DeviceTypeWeb (dict) --

      The branding information configured for web access.

      • LogoUrl (string) --

        The logo URL. This is the link where users can download the logo image. The only supported image format is .png.

      • SupportEmail (string) --

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

      • SupportLink (string) --

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

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

        • (string) --

          • (string) --

DescribeClientBranding (new) Link ¶

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.

See also: AWS API Documentation

Request Syntax

client.describe_client_branding(
    ResourceId='string'
)
type ResourceId:

string

param ResourceId:

[REQUIRED]

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

rtype:

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 URL. This is the link where users can download the logo image. The only supported image format is .png.

      • SupportEmail (string) --

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

      • SupportLink (string) --

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

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

        • (string) --

          • (string) --

    • DeviceTypeOsx (dict) --

      The branding information for macOS devices.

      • LogoUrl (string) --

        The logo URL. This is the link where users can download the logo image. The only supported image format is .png.

      • SupportEmail (string) --

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

      • SupportLink (string) --

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

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

        • (string) --

          • (string) --

    • DeviceTypeAndroid (dict) --

      The branding information for Android devices.

      • LogoUrl (string) --

        The logo URL. This is the link where users can download the logo image. The only supported image format is .png.

      • SupportEmail (string) --

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

      • SupportLink (string) --

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

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

        • (string) --

          • (string) --

    • DeviceTypeIos (dict) --

      The branding information for iOS devices.

      • LogoUrl (string) --

        The logo. This is the link where users can download the logo image. This is the standard-resolution display that has a 1:1 pixel density (or @1x), where one pixel is equal to one point.

      • Logo2xUrl (string) --

        The @2x version of the logo. This is the higher resolution display that offers a scale factor of 2.0 (or @2x).

      • Logo3xUrl (string) --

        The @3x version of the logo. This is the higher resolution display that offers a scale factor of 3.0 (or @3x).

      • SupportEmail (string) --

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

      • SupportLink (string) --

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

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

        • (string) --

          • (string) --

    • DeviceTypeLinux (dict) --

      The branding information for Linux devices.

      • LogoUrl (string) --

        The logo URL. This is the link where users can download the logo image. The only supported image format is .png.

      • SupportEmail (string) --

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

      • SupportLink (string) --

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

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

        • (string) --

          • (string) --

    • DeviceTypeWeb (dict) --

      The branding information for Web access.

      • LogoUrl (string) --

        The logo URL. This is the link where users can download the logo image. The only supported image format is .png.

      • SupportEmail (string) --

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

      • SupportLink (string) --

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

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

        • (string) --

          • (string) --

DeleteClientBranding (new) Link ¶

Deletes customized client branding. Client branding allows you to customize your WorkSpace's client login portal. You can tailor your login portal company logo, the support email address, support link, link to reset password, and a custom message for users trying to sign in.

After you delete your customized client branding, your login portal reverts to the default client branding.

See also: AWS API Documentation

Request Syntax

client.delete_client_branding(
    ResourceId='string',
    Platforms=[
        'DeviceTypeWindows'|'DeviceTypeOsx'|'DeviceTypeAndroid'|'DeviceTypeIos'|'DeviceTypeLinux'|'DeviceTypeWeb',
    ]
)
type ResourceId:

string

param ResourceId:

[REQUIRED]

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

type Platforms:

list

param Platforms:

[REQUIRED]

The device type for which you want to delete client branding.

  • (string) --

rtype:

dict

returns:

Response Syntax

{}

Response Structure

  • (dict) --