delete_client_branding

WorkSpaces.Client.delete_client_branding(**kwargs)

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

response = client.delete_client_branding(
    ResourceId='string',
    Platforms=[
        'DeviceTypeWindows'|'DeviceTypeOsx'|'DeviceTypeAndroid'|'DeviceTypeIos'|'DeviceTypeLinux'|'DeviceTypeWeb',
    ]
)
Parameters
  • ResourceId (string) --

    [REQUIRED]

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

  • Platforms (list) --

    [REQUIRED]

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

    • (string) --
Return type

dict

Returns

Response Syntax

{}

Response Structure

  • (dict) --

Exceptions

  • WorkSpaces.Client.exceptions.InvalidParameterValuesException
  • WorkSpaces.Client.exceptions.ResourceNotFoundException
  • WorkSpaces.Client.exceptions.AccessDeniedException