Amazon WorkSpaces · JSON Structure

Workspaces Default Import Client Branding Attributes Structure

The default client branding attributes to be imported. These attributes display on the client login screen.

Client branding attributes are public facing. Ensure that you do not include sensitive information.

Type: object Properties: 5
DesktopEnd User ComputingVirtual DesktopDesktop as a Service

DefaultImportClientBrandingAttributes is a JSON Structure definition published by Amazon WorkSpaces, describing 5 properties. It conforms to the https://json-structure.org/meta/core/v0/# meta-schema.

Properties

Logo SupportEmail SupportLink ForgotPasswordLink LoginMessage

Meta-schema: https://json-structure.org/meta/core/v0/#

JSON Structure

Raw ↑
{
  "type": "object",
  "properties": {
    "Logo": {
      "allOf": [
        {
          "$ref": "#/components/schemas/DefaultLogo"
        },
        {
          "description": "The logo. The only image format accepted is a binary data object that is converted from a <code>.png</code> file."
        }
      ]
    },
    "SupportEmail": {
      "allOf": [
        {
          "$ref": "#/components/schemas/ClientEmail"
        },
        {
          "description": "<p>The support email. The company's customer support email address.</p> <note> <ul> <li> <p>In each platform type, the <code>SupportEmail</code> and <code>SupportLink</code> parameters are mutually exclusive. You can specify one parameter for each platform type, but not both.</p> </li> <li> <p>The default email is <code>workspaces-feedback@amazon.com</code>.</p> </li> </ul> </note>"
        }
      ]
    },
    "SupportLink": {
      "allOf": [
        {
          "$ref": "#/components/schemas/ClientUrl"
        },
        {
          "description": "<p>The support link. The link for the company's customer support page for their WorkSpace.</p> <note> <ul> <li> <p>In each platform type, the <code>SupportEmail</code> and <code>SupportLink</code> parameters are mutually exclusive. You can specify one parameter for each platform type, but not both.</p> </li> <li> <p>The default support link is <code>workspaces-feedback@amazon.com</code>.</p> </li> </ul> </note>"
        }
      ]
    },
    "ForgotPasswordLink": {
      "allOf": [
        {
          "$ref": "#/components/schemas/ClientUrl"
        },
        {
          "description": "The forgotten password link. This is the web address that users can go to if they forget the password for their WorkSpace."
        }
      ]
    },
    "LoginMessage": {
      "allOf": [
        {
          "$ref": "#/components/schemas/LoginMessage"
        },
        {
          "description": "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 <code>en_US</code>. The HTML tags supported include the following: <code>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</code>."
        }
      ]
    }
  },
  "description": "<p>The default client branding attributes to be imported. These attributes display on the client login screen.</p> <important> <p>Client branding attributes are public facing. Ensure that you do not include sensitive information.</p> </important>",
  "$schema": "https://json-structure.org/meta/core/v0/#",
  "name": "DefaultImportClientBrandingAttributes",
  "$id": "https://raw.githubusercontent.com/api-evangelist/amazon-workspaces/refs/heads/main/json-structure/workspaces-default-import-client-branding-attributes-structure.json"
}